Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-monitor

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ActionGroupsCreateOrUpdateResponse

ActionGroupsCreateOrUpdateResponse: ActionGroupResource & object

Contains response data for the createOrUpdate operation.

ActionGroupsGetResponse

ActionGroupsGetResponse: ActionGroupResource & object

Contains response data for the get operation.

ActionGroupsListByResourceGroupResponse

ActionGroupsListByResourceGroupResponse: ActionGroupList & object

Contains response data for the listByResourceGroup operation.

ActionGroupsListBySubscriptionIdResponse

ActionGroupsListBySubscriptionIdResponse: ActionGroupList & object

Contains response data for the listBySubscriptionId operation.

ActionGroupsUpdateResponse

ActionGroupsUpdateResponse: ActionGroupResource & object

Contains response data for the update operation.

ActionUnion

ActionUnion: Action | AlertingAction | LogToMetricAction

Contains the possible cases for Action.

ActivityLogAlertsCreateOrUpdateResponse

ActivityLogAlertsCreateOrUpdateResponse: ActivityLogAlertResource & object

Contains response data for the createOrUpdate operation.

ActivityLogAlertsGetResponse

ActivityLogAlertsGetResponse: ActivityLogAlertResource & object

Contains response data for the get operation.

ActivityLogAlertsListByResourceGroupResponse

ActivityLogAlertsListByResourceGroupResponse: ActivityLogAlertList & object

Contains response data for the listByResourceGroup operation.

ActivityLogAlertsListBySubscriptionIdResponse

ActivityLogAlertsListBySubscriptionIdResponse: ActivityLogAlertList & object

Contains response data for the listBySubscriptionId operation.

ActivityLogAlertsUpdateResponse

ActivityLogAlertsUpdateResponse: ActivityLogAlertResource & object

Contains response data for the update operation.

ActivityLogsListNextResponse

ActivityLogsListNextResponse: EventDataCollection & object

Contains response data for the listNext operation.

ActivityLogsListResponse

ActivityLogsListResponse: EventDataCollection & object

Contains response data for the list operation.

AggregationType

AggregationType: "None" | "Average" | "Count" | "Minimum" | "Maximum" | "Total"

Defines values for AggregationType. Possible values include: 'None', 'Average', 'Count', 'Minimum', 'Maximum', 'Total'

readonly
enum

{string}

AlertRuleIncidentsGetResponse

AlertRuleIncidentsGetResponse: Incident & object

Contains response data for the get operation.

AlertRuleIncidentsListByAlertRuleResponse

AlertRuleIncidentsListByAlertRuleResponse: IncidentListResult & object

Contains response data for the listByAlertRule operation.

AlertRulesCreateOrUpdateResponse

AlertRulesCreateOrUpdateResponse: AlertRuleResource & object

Contains response data for the createOrUpdate operation.

AlertRulesGetResponse

AlertRulesGetResponse: AlertRuleResource & object

Contains response data for the get operation.

AlertRulesListByResourceGroupResponse

AlertRulesListByResourceGroupResponse: AlertRuleResourceCollection & object

Contains response data for the listByResourceGroup operation.

AlertRulesListBySubscriptionResponse

AlertRulesListBySubscriptionResponse: AlertRuleResourceCollection & object

Contains response data for the listBySubscription operation.

AlertRulesUpdateResponse

AlertRulesUpdateResponse: AlertRuleResource & object

Contains response data for the update operation.

AlertSeverity

AlertSeverity: "0" | "1" | "2" | "3" | "4"

Defines values for AlertSeverity. Possible values include: '0', '1', '2', '3', '4'

readonly
enum

{string}

AutoscaleSettingsCreateOrUpdateResponse

AutoscaleSettingsCreateOrUpdateResponse: AutoscaleSettingResource & object

Contains response data for the createOrUpdate operation.

AutoscaleSettingsGetResponse

AutoscaleSettingsGetResponse: AutoscaleSettingResource & object

Contains response data for the get operation.

AutoscaleSettingsListByResourceGroupNextResponse

AutoscaleSettingsListByResourceGroupNextResponse: AutoscaleSettingResourceCollection & object

Contains response data for the listByResourceGroupNext operation.

AutoscaleSettingsListByResourceGroupResponse

AutoscaleSettingsListByResourceGroupResponse: AutoscaleSettingResourceCollection & object

Contains response data for the listByResourceGroup operation.

AutoscaleSettingsListBySubscriptionNextResponse

AutoscaleSettingsListBySubscriptionNextResponse: AutoscaleSettingResourceCollection & object

Contains response data for the listBySubscriptionNext operation.

AutoscaleSettingsListBySubscriptionResponse

AutoscaleSettingsListBySubscriptionResponse: AutoscaleSettingResourceCollection & object

Contains response data for the listBySubscription operation.

AutoscaleSettingsUpdateResponse

AutoscaleSettingsUpdateResponse: AutoscaleSettingResource & object

Contains response data for the update operation.

CategoryType

CategoryType: "Metrics" | "Logs"

Defines values for CategoryType. Possible values include: 'Metrics', 'Logs'

readonly
enum

{string}

ComparisonOperationType

ComparisonOperationType: "Equals" | "NotEquals" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual"

Defines values for ComparisonOperationType. Possible values include: 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'

readonly
enum

{string}

ConditionOperator

ConditionOperator: "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual"

Defines values for ConditionOperator. Possible values include: 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'

readonly
enum

{string}

ConditionalOperator

ConditionalOperator: "GreaterThan" | "LessThan" | "Equal"

Defines values for ConditionalOperator. Possible values include: 'GreaterThan', 'LessThan', 'Equal'

readonly
enum

{string}

DataStatus

DataStatus: "present" | "notPresent"

Defines values for DataStatus. Possible values include: 'present', 'notPresent'

readonly
enum

{string}

DiagnosticSettingsCategoryGetResponse

DiagnosticSettingsCategoryGetResponse: DiagnosticSettingsCategoryResource & object

Contains response data for the get operation.

DiagnosticSettingsCategoryListResponse

DiagnosticSettingsCategoryListResponse: DiagnosticSettingsCategoryResourceCollection & object

Contains response data for the list operation.

DiagnosticSettingsCreateOrUpdateResponse

DiagnosticSettingsCreateOrUpdateResponse: DiagnosticSettingsResource & object

Contains response data for the createOrUpdate operation.

DiagnosticSettingsGetResponse

DiagnosticSettingsGetResponse: DiagnosticSettingsResource & object

Contains response data for the get operation.

DiagnosticSettingsListResponse

DiagnosticSettingsListResponse: DiagnosticSettingsResourceCollection & object

Contains response data for the list operation.

Enabled

Enabled: "true" | "false"

Defines values for Enabled. Possible values include: 'true', 'false'

readonly
enum

{string}

EventCategoriesListResponse

EventCategoriesListResponse: EventCategoryCollection & object

Contains response data for the list operation.

EventLevel

EventLevel: "Critical" | "Error" | "Warning" | "Informational" | "Verbose"

Defines values for EventLevel. Possible values include: 'Critical', 'Error', 'Warning', 'Informational', 'Verbose'

readonly
enum

{string}

LogProfilesCreateOrUpdateResponse

LogProfilesCreateOrUpdateResponse: LogProfileResource & object

Contains response data for the createOrUpdate operation.

LogProfilesGetResponse

LogProfilesGetResponse: LogProfileResource & object

Contains response data for the get operation.

LogProfilesListResponse

LogProfilesListResponse: LogProfileCollection & object

Contains response data for the list operation.

LogProfilesUpdateResponse

LogProfilesUpdateResponse: LogProfileResource & object

Contains response data for the update operation.

MetricAlertCriteriaUnion

MetricAlertCriteriaUnion: MetricAlertCriteria | MetricAlertSingleResourceMultipleMetricCriteria | MetricAlertMultipleResourceMultipleMetricCriteria

Contains the possible cases for MetricAlertCriteria.

MetricAlertsCreateOrUpdateResponse

MetricAlertsCreateOrUpdateResponse: MetricAlertResource & object

Contains response data for the createOrUpdate operation.

MetricAlertsGetResponse

MetricAlertsGetResponse: MetricAlertResource & object

Contains response data for the get operation.

MetricAlertsListByResourceGroupResponse

MetricAlertsListByResourceGroupResponse: MetricAlertResourceCollection & object

Contains response data for the listByResourceGroup operation.

MetricAlertsListBySubscriptionResponse

MetricAlertsListBySubscriptionResponse: MetricAlertResourceCollection & object

Contains response data for the listBySubscription operation.

MetricAlertsStatusListByNameResponse

MetricAlertsStatusListByNameResponse: MetricAlertStatusCollection & object

Contains response data for the listByName operation.

MetricAlertsStatusListResponse

MetricAlertsStatusListResponse: MetricAlertStatusCollection & object

Contains response data for the list operation.

MetricAlertsUpdateResponse

MetricAlertsUpdateResponse: MetricAlertResource & object

Contains response data for the update operation.

MetricBaselineCalculateBaselineResponse

MetricBaselineCalculateBaselineResponse: CalculateBaselineResponse & object

Contains response data for the calculateBaseline operation.

MetricBaselineGetResponse

MetricBaselineGetResponse: BaselineResponse & object

Contains response data for the get operation.

MetricDefinitionsListResponse

MetricDefinitionsListResponse: MetricDefinitionCollection & object

Contains response data for the list operation.

MetricNamespacesListResponse

MetricNamespacesListResponse: MetricNamespaceCollection & object

Contains response data for the list operation.

MetricStatisticType

MetricStatisticType: "Average" | "Min" | "Max" | "Sum"

Defines values for MetricStatisticType. Possible values include: 'Average', 'Min', 'Max', 'Sum'

readonly
enum

{string}

MetricTriggerType

MetricTriggerType: "Consecutive" | "Total"

Defines values for MetricTriggerType. Possible values include: 'Consecutive', 'Total'

readonly
enum

{string}

MetricsListResponse

MetricsListResponse: Response & object

Contains response data for the list operation.

MultiMetricCriteriaUnion

MultiMetricCriteriaUnion: MultiMetricCriteria | MetricCriteria

Contains the possible cases for MultiMetricCriteria.

OnboardingStatus

OnboardingStatus: "onboarded" | "notOnboarded" | "unknown"

Defines values for OnboardingStatus. Possible values include: 'onboarded', 'notOnboarded', 'unknown'

readonly
enum

{string}

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

ProvisioningState

ProvisioningState: "Succeeded" | "Deploying" | "Canceled" | "Failed"

Defines values for ProvisioningState. Possible values include: 'Succeeded', 'Deploying', 'Canceled', 'Failed'

readonly
enum

{string}

QueryType

QueryType: "ResultCount"

Defines values for QueryType. Possible values include: 'ResultCount'

readonly
enum

{string}

ReceiverStatus

ReceiverStatus: "NotSpecified" | "Enabled" | "Disabled"

Defines values for ReceiverStatus. Possible values include: 'NotSpecified', 'Enabled', 'Disabled'

readonly
enum

{string}

RecurrenceFrequency

RecurrenceFrequency: "None" | "Second" | "Minute" | "Hour" | "Day" | "Week" | "Month" | "Year"

Defines values for RecurrenceFrequency. Possible values include: 'None', 'Second', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year'

readonly
enum

{string}

ResultType

ResultType: "Data" | "Metadata"

Defines values for ResultType. Possible values include: 'Data', 'Metadata'

readonly
enum

{string}

RuleActionUnion

RuleActionUnion: RuleAction | RuleEmailAction | RuleWebhookAction

Contains the possible cases for RuleAction.

RuleConditionUnion

RuleConditionUnion: RuleCondition | ThresholdRuleCondition | LocationThresholdRuleCondition | ManagementEventRuleCondition

Contains the possible cases for RuleCondition.

RuleDataSourceUnion

RuleDataSourceUnion: RuleDataSource | RuleMetricDataSource | RuleManagementEventDataSource

Contains the possible cases for RuleDataSource.

ScaleDirection

ScaleDirection: "None" | "Increase" | "Decrease"

Defines values for ScaleDirection. Possible values include: 'None', 'Increase', 'Decrease'

readonly
enum

{string}

ScaleType

ScaleType: "ChangeCount" | "PercentChangeCount" | "ExactCount"

Defines values for ScaleType. Possible values include: 'ChangeCount', 'PercentChangeCount', 'ExactCount'

readonly
enum

{string}

ScheduledQueryRulesCreateOrUpdateResponse

ScheduledQueryRulesCreateOrUpdateResponse: LogSearchRuleResource & object

Contains response data for the createOrUpdate operation.

ScheduledQueryRulesGetResponse

ScheduledQueryRulesGetResponse: LogSearchRuleResource & object

Contains response data for the get operation.

ScheduledQueryRulesListByResourceGroupResponse

ScheduledQueryRulesListByResourceGroupResponse: LogSearchRuleResourceCollection & object

Contains response data for the listByResourceGroup operation.

ScheduledQueryRulesListBySubscriptionResponse

ScheduledQueryRulesListBySubscriptionResponse: LogSearchRuleResourceCollection & object

Contains response data for the listBySubscription operation.

ScheduledQueryRulesUpdateResponse

ScheduledQueryRulesUpdateResponse: LogSearchRuleResource & object

Contains response data for the update operation.

Sensitivity

Sensitivity: "Low" | "Medium" | "High"

Defines values for Sensitivity. Possible values include: 'Low', 'Medium', 'High'

readonly
enum

{string}

TenantActivityLogsListNextResponse

TenantActivityLogsListNextResponse: EventDataCollection & object

Contains response data for the listNext operation.

TenantActivityLogsListResponse

TenantActivityLogsListResponse: EventDataCollection & object

Contains response data for the list operation.

TimeAggregationOperator

TimeAggregationOperator: "Average" | "Minimum" | "Maximum" | "Total" | "Last"

Defines values for TimeAggregationOperator. Possible values include: 'Average', 'Minimum', 'Maximum', 'Total', 'Last'

readonly
enum

{string}

TimeAggregationType

TimeAggregationType: "Average" | "Minimum" | "Maximum" | "Total" | "Count" | "Last"

Defines values for TimeAggregationType. Possible values include: 'Average', 'Minimum', 'Maximum', 'Total', 'Count', 'Last'

readonly
enum

{string}

Unit

Unit: "Count" | "Bytes" | "Seconds" | "CountPerSecond" | "BytesPerSecond" | "Percent" | "MilliSeconds" | "ByteSeconds" | "Unspecified"

Defines values for Unit. Possible values include: 'Count', 'Bytes', 'Seconds', 'CountPerSecond', 'BytesPerSecond', 'Percent', 'MilliSeconds', 'ByteSeconds', 'Unspecified'

readonly
enum

{string}

VMInsightsGetOnboardingStatusResponse

VMInsightsGetOnboardingStatusResponse: VMInsightsOnboardingStatus & object

Contains response data for the getOnboardingStatus operation.

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const Action

Action: object

Action descriptor.

odatatype

odatatype: "Action"

Polymorphic Discriminator

serializedName

serializedName: string = "Action"

type

type: object

className

className: string = "Action"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Action"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "odata.type"

Const ActionGroupList

ActionGroupList: object
interface

A list of action groups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Provides the link to retrieve the next set of elements.

serializedName

serializedName: string = "ActionGroupList"

__@iterator

  • __@iterator(): IterableIterator<ActionGroupResource>
  • Iterator

    Returns IterableIterator<ActionGroupResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ActionGroupResource>[]): ActionGroupResource[]
  • concat(...items: (T | ConcatArray<T>)[]): ActionGroupResource[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ActionGroupResource>[]

      Additional items to add to the end of array1.

    Returns ActionGroupResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ActionGroupResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ActionGroupResource]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ActionGroupResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ActionGroupResource, index: number, array: ActionGroupResource[]): boolean
        • Parameters

          • value: ActionGroupResource
          • index: number
          • array: ActionGroupResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ActionGroupResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ActionGroupResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ActionGroupResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ActionGroupResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ActionGroupResource, index: number, array: ActionGroupResource[]): boolean
        • Parameters

          • value: ActionGroupResource
          • index: number
          • array: ActionGroupResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ActionGroupResource, index: number, array: ActionGroupResource[]): any
        • Parameters

          • value: ActionGroupResource
          • index: number
          • array: ActionGroupResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ActionGroupResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ActionGroupResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ActionGroupResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ActionGroupResource, index: number, obj: ActionGroupResource[]): boolean
        • Parameters

          • this: void
          • value: ActionGroupResource
          • index: number
          • obj: ActionGroupResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ActionGroupResource, index: number, obj: ActionGroupResource[]): boolean
        • Parameters

          • value: ActionGroupResource
          • index: number
          • obj: ActionGroupResource[]

          Returns boolean

    • Optional thisArg: any

    Returns ActionGroupResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ActionGroupResource, index: number, obj: ActionGroupResource[]): boolean
        • Parameters

          • value: ActionGroupResource
          • index: number
          • obj: ActionGroupResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ActionGroupResource, index: number, array: ActionGroupResource[]): void
        • Parameters

          • value: ActionGroupResource
          • index: number
          • array: ActionGroupResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ActionGroupResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ActionGroupResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ActionGroupResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ActionGroupResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ActionGroupResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ActionGroupResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ActionGroupResource, index: number, array: ActionGroupResource[]): U
        • Parameters

          • value: ActionGroupResource
          • index: number
          • array: ActionGroupResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ActionGroupResource | undefined
  • Removes the last element from an array and returns it.

    Returns ActionGroupResource | undefined

push

  • push(...items: ActionGroupResource[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ActionGroupResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ActionGroupResource
  • reduce(callbackfn: function, initialValue: ActionGroupResource): ActionGroupResource
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ActionGroupResource, currentValue: ActionGroupResource, currentIndex: number, array: ActionGroupResource[]): ActionGroupResource
        • Parameters

          • previousValue: ActionGroupResource
          • currentValue: ActionGroupResource
          • currentIndex: number
          • array: ActionGroupResource[]

          Returns ActionGroupResource

    Returns ActionGroupResource

  • Parameters

    • callbackfn: function
        • (previousValue: ActionGroupResource, currentValue: ActionGroupResource, currentIndex: number, array: ActionGroupResource[]): ActionGroupResource
        • Parameters

          • previousValue: ActionGroupResource
          • currentValue: ActionGroupResource
          • currentIndex: number
          • array: ActionGroupResource[]

          Returns ActionGroupResource

    • initialValue: ActionGroupResource

    Returns ActionGroupResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ActionGroupResource, currentIndex: number, array: ActionGroupResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: ActionGroupResource
          • currentIndex: number
          • array: ActionGroupResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ActionGroupResource
  • reduceRight(callbackfn: function, initialValue: ActionGroupResource): ActionGroupResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ActionGroupResource, currentValue: ActionGroupResource, currentIndex: number, array: ActionGroupResource[]): ActionGroupResource
        • Parameters

          • previousValue: ActionGroupResource
          • currentValue: ActionGroupResource
          • currentIndex: number
          • array: ActionGroupResource[]

          Returns ActionGroupResource

    Returns ActionGroupResource

  • Parameters

    • callbackfn: function
        • (previousValue: ActionGroupResource, currentValue: ActionGroupResource, currentIndex: number, array: ActionGroupResource[]): ActionGroupResource
        • Parameters

          • previousValue: ActionGroupResource
          • currentValue: ActionGroupResource
          • currentIndex: number
          • array: ActionGroupResource[]

          Returns ActionGroupResource

    • initialValue: ActionGroupResource

    Returns ActionGroupResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ActionGroupResource, currentIndex: number, array: ActionGroupResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: ActionGroupResource
          • currentIndex: number
          • array: ActionGroupResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ActionGroupResource[]
  • Reverses the elements in an Array.

    Returns ActionGroupResource[]

shift

  • shift(): ActionGroupResource | undefined
  • Removes the first element from an array and returns it.

    Returns ActionGroupResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ActionGroupResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ActionGroupResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ActionGroupResource, index: number, array: ActionGroupResource[]): boolean
        • Parameters

          • value: ActionGroupResource
          • index: number
          • array: ActionGroupResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ActionGroupResource[]
  • splice(start: number, deleteCount: number, ...items: ActionGroupResource[]): ActionGroupResource[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ActionGroupResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ActionGroupResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ActionGroupResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ActionGroupResource[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ActionGroupResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ActionGroupResource>
  • Returns an iterable of values in the array

    Returns IterableIterator<ActionGroupResource>

type

type: object

className

className: string = "ActionGroupList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActionGroupResource"

name

name: "Composite" = "Composite"

Const ActionGroupPatchBody

ActionGroupPatchBody: object

An action group object for the body of patch operations.

Optional enabled

enabled: undefined | false | true

Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated. Default value: true.

serializedName

serializedName: string = "ActionGroupPatchBody"

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "ActionGroupPatchBody"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const ActionGroupResource

ActionGroupResource: object

An action group resource.

Optional armRoleReceivers

armRoleReceivers: ArmRoleReceiver[]

The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.

Optional automationRunbookReceivers

automationRunbookReceivers: AutomationRunbookReceiver[]

The list of AutomationRunbook receivers that are part of this action group.

Optional azureAppPushReceivers

azureAppPushReceivers: AzureAppPushReceiver[]

The list of AzureAppPush receivers that are part of this action group.

Optional azureFunctionReceivers

azureFunctionReceivers: AzureFunctionReceiver[]

The list of azure function receivers that are part of this action group.

Optional emailReceivers

emailReceivers: EmailReceiver[]

The list of email receivers that are part of this action group.

enabled

enabled: boolean

Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Default value: true.

groupShortName

groupShortName: string

The short name of the action group. This will be used in SMS messages.

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional itsmReceivers

itsmReceivers: ItsmReceiver[]

The list of ITSM receivers that are part of this action group.

location

location: string

Resource location

Optional logicAppReceivers

logicAppReceivers: LogicAppReceiver[]

The list of logic app receivers that are part of this action group.

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ActionGroupResource"

Optional smsReceivers

smsReceivers: SmsReceiver[]

The list of SMS receivers that are part of this action group.

Optional tags

tags: undefined | object

Resource tags

Optional voiceReceivers

voiceReceivers: VoiceReceiver[]

The list of voice receivers that are part of this action group.

Optional webhookReceivers

webhookReceivers: WebhookReceiver[]

The list of webhook receivers that are part of this action group.

type

type: object

className

className: string = "ActionGroupResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

armRoleReceivers

armRoleReceivers: object

serializedName

serializedName: string = "properties.armRoleReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArmRoleReceiver"

name

name: "Composite" = "Composite"

automationRunbookReceivers

automationRunbookReceivers: object

serializedName

serializedName: string = "properties.automationRunbookReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutomationRunbookReceiver"

name

name: "Composite" = "Composite"

azureAppPushReceivers

azureAppPushReceivers: object

serializedName

serializedName: string = "properties.azureAppPushReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureAppPushReceiver"

name

name: "Composite" = "Composite"

azureFunctionReceivers

azureFunctionReceivers: object

serializedName

serializedName: string = "properties.azureFunctionReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFunctionReceiver"

name

name: "Composite" = "Composite"

emailReceivers

emailReceivers: object

serializedName

serializedName: string = "properties.emailReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailReceiver"

name

name: "Composite" = "Composite"

enabled

enabled: object

defaultValue

defaultValue: boolean = true

required

required: true = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

groupShortName

groupShortName: object

required

required: true = true

serializedName

serializedName: string = "properties.groupShortName"

constraints

constraints: object

MaxLength

MaxLength: number = 12

type

type: object

name

name: "String" = "String"

itsmReceivers

itsmReceivers: object

serializedName

serializedName: string = "properties.itsmReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ItsmReceiver"

name

name: "Composite" = "Composite"

logicAppReceivers

logicAppReceivers: object

serializedName

serializedName: string = "properties.logicAppReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LogicAppReceiver"

name

name: "Composite" = "Composite"

smsReceivers

smsReceivers: object

serializedName

serializedName: string = "properties.smsReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SmsReceiver"

name

name: "Composite" = "Composite"

voiceReceivers

voiceReceivers: object

serializedName

serializedName: string = "properties.voiceReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VoiceReceiver"

name

name: "Composite" = "Composite"

webhookReceivers

webhookReceivers: object

serializedName

serializedName: string = "properties.webhookReceivers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WebhookReceiver"

name

name: "Composite" = "Composite"

Const ActivityLogAlertActionGroup

ActivityLogAlertActionGroup: object

A pointer to an Azure Action Group.

actionGroupId

actionGroupId: string

The resourceId of the action group. This cannot be null or empty.

serializedName

serializedName: string = "ActivityLogAlertActionGroup"

Optional webhookProperties

webhookProperties: undefined | object

the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.

type

type: object

className

className: string = "ActivityLogAlertActionGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionGroupId

actionGroupId: object

required

required: true = true

serializedName

serializedName: string = "actionGroupId"

type

type: object

name

name: "String" = "String"

webhookProperties

webhookProperties: object

serializedName

serializedName: string = "webhookProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const ActivityLogAlertActionList

ActivityLogAlertActionList: object

A list of activity log alert actions.

Optional actionGroups

actionGroups: ActivityLogAlertActionGroup[]

The list of activity log alerts.

serializedName

serializedName: string = "ActivityLogAlertActionList"

type

type: object

className

className: string = "ActivityLogAlertActionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionGroups

actionGroups: object

serializedName

serializedName: string = "actionGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityLogAlertActionGroup"

name

name: "Composite" = "Composite"

Const ActivityLogAlertAllOfCondition

ActivityLogAlertAllOfCondition: object

An Activity Log alert condition that is met when all its member conditions are met.

allOf

allOf: ActivityLogAlertLeafCondition[]

The list of activity log alert conditions.

serializedName

serializedName: string = "ActivityLogAlertAllOfCondition"

type

type: object

className

className: string = "ActivityLogAlertAllOfCondition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allOf

allOf: object

required

required: true = true

serializedName

serializedName: string = "allOf"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityLogAlertLeafCondition"

name

name: "Composite" = "Composite"

Const ActivityLogAlertLeafCondition

ActivityLogAlertLeafCondition: object

An Activity Log alert condition that is met by comparing an activity log field and value.

equals

equals: string

The field value will be compared to this value (case-insensitive) to determine if the condition is met.

field

field: string

The name of the field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'.

serializedName

serializedName: string = "ActivityLogAlertLeafCondition"

type

type: object

className

className: string = "ActivityLogAlertLeafCondition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

equals

equals: object

required

required: true = true

serializedName

serializedName: string = "equals"

type

type: object

name

name: "String" = "String"

field

field: object

required

required: true = true

serializedName

serializedName: string = "field"

type

type: object

name

name: "String" = "String"

Const ActivityLogAlertList

ActivityLogAlertList: object
interface

A list of activity log alerts.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Provides the link to retrieve the next set of elements.

serializedName

serializedName: string = "ActivityLogAlertList"

__@iterator

  • __@iterator(): IterableIterator<ActivityLogAlertResource>
  • Iterator

    Returns IterableIterator<ActivityLogAlertResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ActivityLogAlertResource>[]): ActivityLogAlertResource[]
  • concat(...items: (T | ConcatArray<T>)[]): ActivityLogAlertResource[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ActivityLogAlertResource>[]

      Additional items to add to the end of array1.

    Returns ActivityLogAlertResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ActivityLogAlertResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ActivityLogAlertResource]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ActivityLogAlertResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ActivityLogAlertResource, index: number, array: ActivityLogAlertResource[]): boolean
        • Parameters

          • value: ActivityLogAlertResource
          • index: number
          • array: ActivityLogAlertResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ActivityLogAlertResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ActivityLogAlertResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ActivityLogAlertResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ActivityLogAlertResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ActivityLogAlertResource, index: number, array: ActivityLogAlertResource[]): boolean
        • Parameters

          • value: ActivityLogAlertResource
          • index: number
          • array: ActivityLogAlertResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ActivityLogAlertResource, index: number, array: ActivityLogAlertResource[]): any
        • Parameters

          • value: ActivityLogAlertResource
          • index: number
          • array: ActivityLogAlertResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ActivityLogAlertResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ActivityLogAlertResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ActivityLogAlertResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ActivityLogAlertResource, index: number, obj: ActivityLogAlertResource[]): boolean
        • Parameters

          • this: void
          • value: ActivityLogAlertResource
          • index: number
          • obj: ActivityLogAlertResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ActivityLogAlertResource, index: number, obj: ActivityLogAlertResource[]): boolean
        • Parameters

          • value: ActivityLogAlertResource
          • index: number
          • obj: ActivityLogAlertResource[]

          Returns boolean

    • Optional thisArg: any

    Returns ActivityLogAlertResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ActivityLogAlertResource, index: number, obj: ActivityLogAlertResource[]): boolean
        • Parameters

          • value: ActivityLogAlertResource
          • index: number
          • obj: ActivityLogAlertResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ActivityLogAlertResource, index: number, array: ActivityLogAlertResource[]): void
        • Parameters

          • value: ActivityLogAlertResource
          • index: number
          • array: ActivityLogAlertResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ActivityLogAlertResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ActivityLogAlertResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ActivityLogAlertResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ActivityLogAlertResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ActivityLogAlertResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ActivityLogAlertResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ActivityLogAlertResource, index: number, array: ActivityLogAlertResource[]): U
        • Parameters

          • value: ActivityLogAlertResource
          • index: number
          • array: ActivityLogAlertResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ActivityLogAlertResource | undefined
  • Removes the last element from an array and returns it.

    Returns ActivityLogAlertResource | undefined

push

  • push(...items: ActivityLogAlertResource[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ActivityLogAlertResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ActivityLogAlertResource
  • reduce(callbackfn: function, initialValue: ActivityLogAlertResource): ActivityLogAlertResource
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ActivityLogAlertResource, currentValue: ActivityLogAlertResource, currentIndex: number, array: ActivityLogAlertResource[]): ActivityLogAlertResource
        • Parameters

          • previousValue: ActivityLogAlertResource
          • currentValue: ActivityLogAlertResource
          • currentIndex: number
          • array: ActivityLogAlertResource[]

          Returns ActivityLogAlertResource

    Returns ActivityLogAlertResource

  • Parameters

    • callbackfn: function
        • (previousValue: ActivityLogAlertResource, currentValue: ActivityLogAlertResource, currentIndex: number, array: ActivityLogAlertResource[]): ActivityLogAlertResource
        • Parameters

          • previousValue: ActivityLogAlertResource
          • currentValue: ActivityLogAlertResource
          • currentIndex: number
          • array: ActivityLogAlertResource[]

          Returns ActivityLogAlertResource

    • initialValue: ActivityLogAlertResource

    Returns ActivityLogAlertResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ActivityLogAlertResource, currentIndex: number, array: ActivityLogAlertResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: ActivityLogAlertResource
          • currentIndex: number
          • array: ActivityLogAlertResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ActivityLogAlertResource
  • reduceRight(callbackfn: function, initialValue: ActivityLogAlertResource): ActivityLogAlertResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ActivityLogAlertResource, currentValue: ActivityLogAlertResource, currentIndex: number, array: ActivityLogAlertResource[]): ActivityLogAlertResource
        • Parameters

          • previousValue: ActivityLogAlertResource
          • currentValue: ActivityLogAlertResource
          • currentIndex: number
          • array: ActivityLogAlertResource[]

          Returns ActivityLogAlertResource

    Returns ActivityLogAlertResource

  • Parameters

    • callbackfn: function
        • (previousValue: ActivityLogAlertResource, currentValue: ActivityLogAlertResource, currentIndex: number, array: ActivityLogAlertResource[]): ActivityLogAlertResource
        • Parameters

          • previousValue: ActivityLogAlertResource
          • currentValue: ActivityLogAlertResource
          • currentIndex: number
          • array: ActivityLogAlertResource[]

          Returns ActivityLogAlertResource

    • initialValue: ActivityLogAlertResource

    Returns ActivityLogAlertResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ActivityLogAlertResource, currentIndex: number, array: ActivityLogAlertResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: ActivityLogAlertResource
          • currentIndex: number
          • array: ActivityLogAlertResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ActivityLogAlertResource[]
  • Reverses the elements in an Array.

    Returns ActivityLogAlertResource[]

shift

  • shift(): ActivityLogAlertResource | undefined
  • Removes the first element from an array and returns it.

    Returns ActivityLogAlertResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ActivityLogAlertResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ActivityLogAlertResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ActivityLogAlertResource, index: number, array: ActivityLogAlertResource[]): boolean
        • Parameters

          • value: ActivityLogAlertResource
          • index: number
          • array: ActivityLogAlertResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ActivityLogAlertResource[]
  • splice(start: number, deleteCount: number, ...items: ActivityLogAlertResource[]): ActivityLogAlertResource[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ActivityLogAlertResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ActivityLogAlertResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ActivityLogAlertResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ActivityLogAlertResource[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ActivityLogAlertResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ActivityLogAlertResource>
  • Returns an iterable of values in the array

    Returns IterableIterator<ActivityLogAlertResource>

type

type: object

className

className: string = "ActivityLogAlertList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityLogAlertResource"

name

name: "Composite" = "Composite"

Const ActivityLogAlertPatchBody

ActivityLogAlertPatchBody: object

An activity log alert object for the body of patch operations.

Optional enabled

enabled: undefined | false | true

Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. Default value: true.

serializedName

serializedName: string = "ActivityLogAlertPatchBody"

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "ActivityLogAlertPatchBody"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const ActivityLogAlertResource

ActivityLogAlertResource: object

An activity log alert resource.

actions

actions: ActivityLogAlertActionList

The actions that will activate when the condition is met.

condition

condition: ActivityLogAlertAllOfCondition

The condition that will cause this alert to activate.

Optional description

description: undefined | string

A description of this activity log alert.

Optional enabled

enabled: undefined | false | true

Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. Default value: true.

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

scopes

scopes: string[]

A list of resourceIds that will be used as prefixes. The alert will only apply to activityLogs with resourceIds that fall under one of these prefixes. This list must include at least one item.

serializedName

serializedName: string = "ActivityLogAlertResource"

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "ActivityLogAlertResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actions

actions: object

required

required: true = true

serializedName

serializedName: string = "properties.actions"

type

type: object

className

className: string = "ActivityLogAlertActionList"

name

name: "Composite" = "Composite"

condition

condition: object

required

required: true = true

serializedName

serializedName: string = "properties.condition"

type

type: object

className

className: string = "ActivityLogAlertAllOfCondition"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

scopes

scopes: object

required

required: true = true

serializedName

serializedName: string = "properties.scopes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AlertRuleResource

AlertRuleResource: object

The alert rule resource.

Optional actions

actions: RuleActionUnion[]

the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

alertRuleResourceName

alertRuleResourceName: string

the name of the alert rule.

condition

the condition that results in the alert rule being activated.

Optional description

description: undefined | string

the description of the alert rule that will be included in the alert email.

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

isEnabled

isEnabled: boolean

the flag that indicates whether the alert rule is enabled.

Optional lastUpdatedTime

lastUpdatedTime: Date

Last time the rule was updated in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AlertRuleResource"

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "AlertRuleResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actions

actions: object

serializedName

serializedName: string = "properties.actions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RuleAction"

name

name: "Composite" = "Composite"

alertRuleResourceName

alertRuleResourceName: object

required

required: true = true

serializedName

serializedName: string = "properties.name"

type

type: object

name

name: "String" = "String"

condition

condition: object

required

required: true = true

serializedName

serializedName: string = "properties.condition"

type

type: object

className

className: string = "RuleCondition"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isEnabled

isEnabled: object

required

required: true = true

serializedName

serializedName: string = "properties.isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

lastUpdatedTime

lastUpdatedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastUpdatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const AlertRuleResourceCollection

AlertRuleResourceCollection: object
interface

Represents a collection of alert rule resources.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "AlertRuleResourceCollection"

__@iterator

  • __@iterator(): IterableIterator<AlertRuleResource>
  • Iterator

    Returns IterableIterator<AlertRuleResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AlertRuleResource>[]): AlertRuleResource[]
  • concat(...items: (T | ConcatArray<T>)[]): AlertRuleResource[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AlertRuleResource>[]

      Additional items to add to the end of array1.

    Returns AlertRuleResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AlertRuleResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AlertRuleResource]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AlertRuleResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AlertRuleResource, index: number, array: AlertRuleResource[]): boolean
        • Parameters

          • value: AlertRuleResource
          • index: number
          • array: AlertRuleResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AlertRuleResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AlertRuleResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AlertRuleResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AlertRuleResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AlertRuleResource, index: number, array: AlertRuleResource[]): boolean
        • Parameters

          • value: AlertRuleResource
          • index: number
          • array: AlertRuleResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AlertRuleResource, index: number, array: AlertRuleResource[]): any
        • Parameters

          • value: AlertRuleResource
          • index: number
          • array: AlertRuleResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AlertRuleResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AlertRuleResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AlertRuleResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AlertRuleResource, index: number, obj: AlertRuleResource[]): boolean
        • Parameters

          • this: void
          • value: AlertRuleResource
          • index: number
          • obj: AlertRuleResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AlertRuleResource, index: number, obj: AlertRuleResource[]): boolean
        • Parameters

          • value: AlertRuleResource
          • index: number
          • obj: AlertRuleResource[]

          Returns boolean

    • Optional thisArg: any

    Returns AlertRuleResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AlertRuleResource, index: number, obj: AlertRuleResource[]): boolean
        • Parameters

          • value: AlertRuleResource
          • index: number
          • obj: AlertRuleResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AlertRuleResource, index: number, array: AlertRuleResource[]): void
        • Parameters

          • value: AlertRuleResource
          • index: number
          • array: AlertRuleResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AlertRuleResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AlertRuleResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AlertRuleResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AlertRuleResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AlertRuleResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AlertRuleResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AlertRuleResource, index: number, array: AlertRuleResource[]): U
        • Parameters

          • value: AlertRuleResource
          • index: number
          • array: AlertRuleResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AlertRuleResource | undefined
  • Removes the last element from an array and returns it.

    Returns AlertRuleResource | undefined

push

  • push(...items: AlertRuleResource[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AlertRuleResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AlertRuleResource
  • reduce(callbackfn: function, initialValue: AlertRuleResource): AlertRuleResource
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AlertRuleResource, currentValue: AlertRuleResource, currentIndex: number, array: AlertRuleResource[]): AlertRuleResource
        • Parameters

          • previousValue: AlertRuleResource
          • currentValue: AlertRuleResource
          • currentIndex: number
          • array: AlertRuleResource[]

          Returns AlertRuleResource

    Returns AlertRuleResource

  • Parameters

    • callbackfn: function
        • (previousValue: AlertRuleResource, currentValue: AlertRuleResource, currentIndex: number, array: AlertRuleResource[]): AlertRuleResource
        • Parameters

          • previousValue: AlertRuleResource
          • currentValue: AlertRuleResource
          • currentIndex: number
          • array: AlertRuleResource[]

          Returns AlertRuleResource

    • initialValue: AlertRuleResource

    Returns AlertRuleResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AlertRuleResource, currentIndex: number, array: AlertRuleResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: AlertRuleResource
          • currentIndex: number
          • array: AlertRuleResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AlertRuleResource
  • reduceRight(callbackfn: function, initialValue: AlertRuleResource): AlertRuleResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AlertRuleResource, currentValue: AlertRuleResource, currentIndex: number, array: AlertRuleResource[]): AlertRuleResource
        • Parameters

          • previousValue: AlertRuleResource
          • currentValue: AlertRuleResource
          • currentIndex: number
          • array: AlertRuleResource[]

          Returns AlertRuleResource

    Returns AlertRuleResource

  • Parameters

    • callbackfn: function
        • (previousValue: AlertRuleResource, currentValue: AlertRuleResource, currentIndex: number, array: AlertRuleResource[]): AlertRuleResource
        • Parameters

          • previousValue: AlertRuleResource
          • currentValue: AlertRuleResource
          • currentIndex: number
          • array: AlertRuleResource[]

          Returns AlertRuleResource

    • initialValue: AlertRuleResource

    Returns AlertRuleResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AlertRuleResource, currentIndex: number, array: AlertRuleResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: AlertRuleResource
          • currentIndex: number
          • array: AlertRuleResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AlertRuleResource[]
  • Reverses the elements in an Array.

    Returns AlertRuleResource[]

shift

  • shift(): AlertRuleResource | undefined
  • Removes the first element from an array and returns it.

    Returns AlertRuleResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AlertRuleResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AlertRuleResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AlertRuleResource, index: number, array: AlertRuleResource[]): boolean
        • Parameters

          • value: AlertRuleResource
          • index: number
          • array: AlertRuleResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AlertRuleResource[]
  • splice(start: number, deleteCount: number, ...items: AlertRuleResource[]): AlertRuleResource[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AlertRuleResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AlertRuleResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns AlertRuleResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AlertRuleResource[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AlertRuleResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AlertRuleResource>
  • Returns an iterable of values in the array

    Returns IterableIterator<AlertRuleResource>

type

type: object

className

className: string = "AlertRuleResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AlertRuleResource"

name

name: "Composite" = "Composite"

Const AlertRuleResourcePatch

AlertRuleResourcePatch: object

The alert rule object for patch operations.

Optional actions

actions: RuleActionUnion[]

the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

condition

the condition that results in the alert rule being activated.

Optional description

description: undefined | string

the description of the alert rule that will be included in the alert email.

isEnabled

isEnabled: boolean

the flag that indicates whether the alert rule is enabled.

Optional lastUpdatedTime

lastUpdatedTime: Date

Last time the rule was updated in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

name

name: string

the name of the alert rule.

serializedName

serializedName: string = "AlertRuleResourcePatch"

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "AlertRuleResourcePatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actions

actions: object

serializedName

serializedName: string = "properties.actions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RuleAction"

name

name: "Composite" = "Composite"

condition

condition: object

required

required: true = true

serializedName

serializedName: string = "properties.condition"

type

type: object

className

className: string = "RuleCondition"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isEnabled

isEnabled: object

required

required: true = true

serializedName

serializedName: string = "properties.isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

lastUpdatedTime

lastUpdatedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastUpdatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

required

required: true = true

serializedName

serializedName: string = "properties.name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const AlertingAction

AlertingAction: object

Specify action need to be taken when rule type is Alert

Optional aznsAction

aznsAction: AzNsActionGroup

Azure action group reference.

odatatype

odatatype: "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"

Polymorphic Discriminator

serializedName

serializedName: string = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"

severity

severity: AlertSeverity

Severity of the alert. Possible values include: '0', '1', '2', '3', '4'

Optional throttlingInMin

throttlingInMin: undefined | number

time (in minutes) for which Alerts should be throttled or suppressed.

trigger

trigger: TriggerCondition

The trigger condition that results in the alert rule being.

type

type: object

className

className: string = "AlertingAction"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Action.type.polymorphicDiscriminator

uberParent

uberParent: string = "Action"

modelProperties

modelProperties: object

aznsAction

aznsAction: object

serializedName

serializedName: string = "aznsAction"

type

type: object

className

className: string = "AzNsActionGroup"

name

name: "Composite" = "Composite"

severity

severity: object

required

required: true = true

serializedName

serializedName: string = "severity"

type

type: object

name

name: "String" = "String"

throttlingInMin

throttlingInMin: object

serializedName

serializedName: string = "throttlingInMin"

type

type: object

name

name: "Number" = "Number"

trigger

trigger: object

required

required: true = true

serializedName

serializedName: string = "trigger"

type

type: object

className

className: string = "TriggerCondition"

name

name: "Composite" = "Composite"

Const ArmRoleReceiver

ArmRoleReceiver: object

An arm role receiver.

name

name: string

The name of the arm role receiver. Names must be unique across all receivers within an action group.

roleId

roleId: string

The arm role id.

serializedName

serializedName: string = "ArmRoleReceiver"

useCommonAlertSchema

useCommonAlertSchema: boolean

Indicates whether to use common alert schema.

type

type: object

className

className: string = "ArmRoleReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

roleId

roleId: object

required

required: true = true

serializedName

serializedName: string = "roleId"

type

type: object

name

name: "String" = "String"

useCommonAlertSchema

useCommonAlertSchema: object

required

required: true = true

serializedName

serializedName: string = "useCommonAlertSchema"

type

type: object

name

name: "Boolean" = "Boolean"

Const AutomationRunbookReceiver

AutomationRunbookReceiver: object

The Azure Automation Runbook notification receiver.

automationAccountId

automationAccountId: string

The Azure automation account Id which holds this runbook and authenticate to Azure resource.

isGlobalRunbook

isGlobalRunbook: boolean

Indicates whether this instance is global runbook.

Optional name

name: undefined | string

Indicates name of the webhook.

runbookName

runbookName: string

The name for this runbook.

serializedName

serializedName: string = "AutomationRunbookReceiver"

Optional serviceUri

serviceUri: undefined | string

The URI where webhooks should be sent.

useCommonAlertSchema

useCommonAlertSchema: boolean

Indicates whether to use common alert schema.

webhookResourceId

webhookResourceId: string

The resource id for webhook linked to this runbook.

type

type: object

className

className: string = "AutomationRunbookReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

automationAccountId

automationAccountId: object

required

required: true = true

serializedName

serializedName: string = "automationAccountId"

type

type: object

name

name: "String" = "String"

isGlobalRunbook

isGlobalRunbook: object

required

required: true = true

serializedName

serializedName: string = "isGlobalRunbook"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

runbookName

runbookName: object

required

required: true = true

serializedName

serializedName: string = "runbookName"

type

type: object

name

name: "String" = "String"

serviceUri

serviceUri: object

serializedName

serializedName: string = "serviceUri"

type

type: object

name

name: "String" = "String"

useCommonAlertSchema

useCommonAlertSchema: object

required

required: true = true

serializedName

serializedName: string = "useCommonAlertSchema"

type

type: object

name

name: "Boolean" = "Boolean"

webhookResourceId

webhookResourceId: object

required

required: true = true

serializedName

serializedName: string = "webhookResourceId"

type

type: object

name

name: "String" = "String"

Const AutoscaleNotification

AutoscaleNotification: object

Autoscale notification.

Optional email

the email notification.

serializedName

serializedName: string = "AutoscaleNotification"

Optional webhooks

webhooks: WebhookNotification[]

the collection of webhook notifications.

type

type: object

className

className: string = "AutoscaleNotification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

email

email: object

serializedName

serializedName: string = "email"

type

type: object

className

className: string = "EmailNotification"

name

name: "Composite" = "Composite"

operation

operation: object

defaultValue

defaultValue: string = "Scale"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

webhooks

webhooks: object

serializedName

serializedName: string = "webhooks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WebhookNotification"

name

name: "Composite" = "Composite"

Const AutoscaleProfile

AutoscaleProfile: object

Autoscale profile.

capacity

capacity: ScaleCapacity

the number of instances that can be used during this profile.

Optional fixedDate

fixedDate: TimeWindow

the specific date-time for the profile. This element is not used if the Recurrence element is used.

name

name: string

the name of the profile.

Optional recurrence

recurrence: Recurrence

the repeating times at which this profile begins. This element is not used if the FixedDate element is used.

rules

rules: ScaleRule[]

the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified.

serializedName

serializedName: string = "AutoscaleProfile"

type

type: object

className

className: string = "AutoscaleProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

required

required: true = true

serializedName

serializedName: string = "capacity"

type

type: object

className

className: string = "ScaleCapacity"

name

name: "Composite" = "Composite"

fixedDate

fixedDate: object

serializedName

serializedName: string = "fixedDate"

type

type: object

className

className: string = "TimeWindow"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

recurrence

recurrence: object

serializedName

serializedName: string = "recurrence"

type

type: object

className

className: string = "Recurrence"

name

name: "Composite" = "Composite"

rules

rules: object

required

required: true = true

serializedName

serializedName: string = "rules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ScaleRule"

name

name: "Composite" = "Composite"

Const AutoscaleSettingResource

AutoscaleSettingResource: object

The autoscale setting resource.

Optional autoscaleSettingResourceName

autoscaleSettingResourceName: undefined | string

the name of the autoscale setting.

Optional enabled

enabled: undefined | false | true

the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'. Default value: true.

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

Optional notifications

notifications: AutoscaleNotification[]

the collection of notifications.

profiles

profiles: AutoscaleProfile[]

the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

serializedName

serializedName: string = "AutoscaleSettingResource"

Optional tags

tags: undefined | object

Resource tags

Optional targetResourceUri

targetResourceUri: undefined | string

the resource identifier of the resource that the autoscale setting should be added to.

type

type: object

className

className: string = "AutoscaleSettingResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoscaleSettingResourceName

autoscaleSettingResourceName: object

serializedName

serializedName: string = "properties.name"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

notifications

notifications: object

serializedName

serializedName: string = "properties.notifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutoscaleNotification"

name

name: "Composite" = "Composite"

profiles

profiles: object

required

required: true = true

serializedName

serializedName: string = "properties.profiles"

constraints

constraints: object

MaxItems

MaxItems: number = 20

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutoscaleProfile"

name

name: "Composite" = "Composite"

targetResourceUri

targetResourceUri: object

serializedName

serializedName: string = "properties.targetResourceUri"

type

type: object

name

name: "String" = "String"

Const AutoscaleSettingResourceCollection

AutoscaleSettingResourceCollection: object
interface

Represents a collection of autoscale setting resources.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of results.

serializedName

serializedName: string = "AutoscaleSettingResourceCollection"

__@iterator

  • __@iterator(): IterableIterator<AutoscaleSettingResource>
  • Iterator

    Returns IterableIterator<AutoscaleSettingResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AutoscaleSettingResource>[]): AutoscaleSettingResource[]
  • concat(...items: (T | ConcatArray<T>)[]): AutoscaleSettingResource[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AutoscaleSettingResource>[]

      Additional items to add to the end of array1.

    Returns AutoscaleSettingResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AutoscaleSettingResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AutoscaleSettingResource]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AutoscaleSettingResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AutoscaleSettingResource, index: number, array: AutoscaleSettingResource[]): boolean
        • Parameters

          • value: AutoscaleSettingResource
          • index: number
          • array: AutoscaleSettingResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AutoscaleSettingResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AutoscaleSettingResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AutoscaleSettingResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AutoscaleSettingResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AutoscaleSettingResource, index: number, array: AutoscaleSettingResource[]): boolean
        • Parameters

          • value: AutoscaleSettingResource
          • index: number
          • array: AutoscaleSettingResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AutoscaleSettingResource, index: number, array: AutoscaleSettingResource[]): any
        • Parameters

          • value: AutoscaleSettingResource
          • index: number
          • array: AutoscaleSettingResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AutoscaleSettingResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AutoscaleSettingResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AutoscaleSettingResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AutoscaleSettingResource, index: number, obj: AutoscaleSettingResource[]): boolean
        • Parameters

          • this: void
          • value: AutoscaleSettingResource
          • index: number
          • obj: AutoscaleSettingResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AutoscaleSettingResource, index: number, obj: AutoscaleSettingResource[]): boolean
        • Parameters

          • value: AutoscaleSettingResource
          • index: number
          • obj: AutoscaleSettingResource[]

          Returns boolean

    • Optional thisArg: any

    Returns AutoscaleSettingResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AutoscaleSettingResource, index: number, obj: AutoscaleSettingResource[]): boolean
        • Parameters

          • value: AutoscaleSettingResource
          • index: number
          • obj: AutoscaleSettingResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AutoscaleSettingResource, index: number, array: AutoscaleSettingResource[]): void
        • Parameters

          • value: AutoscaleSettingResource
          • index: number
          • array: AutoscaleSettingResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AutoscaleSettingResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AutoscaleSettingResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AutoscaleSettingResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AutoscaleSettingResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AutoscaleSettingResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AutoscaleSettingResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AutoscaleSettingResource, index: number, array: AutoscaleSettingResource[]): U
        • Parameters

          • value: AutoscaleSettingResource
          • index: number
          • array: AutoscaleSettingResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AutoscaleSettingResource | undefined
  • Removes the last element from an array and returns it.

    Returns AutoscaleSettingResource | undefined

push

  • push(...items: AutoscaleSettingResource[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AutoscaleSettingResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AutoscaleSettingResource
  • reduce(callbackfn: function, initialValue: AutoscaleSettingResource): AutoscaleSettingResource
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AutoscaleSettingResource, currentValue: AutoscaleSettingResource, currentIndex: number, array: AutoscaleSettingResource[]): AutoscaleSettingResource
        • Parameters

          • previousValue: AutoscaleSettingResource
          • currentValue: AutoscaleSettingResource
          • currentIndex: number
          • array: AutoscaleSettingResource[]

          Returns AutoscaleSettingResource

    Returns AutoscaleSettingResource

  • Parameters

    • callbackfn: function
        • (previousValue: AutoscaleSettingResource, currentValue: AutoscaleSettingResource, currentIndex: number, array: AutoscaleSettingResource[]): AutoscaleSettingResource
        • Parameters

          • previousValue: AutoscaleSettingResource
          • currentValue: AutoscaleSettingResource
          • currentIndex: number
          • array: AutoscaleSettingResource[]

          Returns AutoscaleSettingResource

    • initialValue: AutoscaleSettingResource

    Returns AutoscaleSettingResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AutoscaleSettingResource, currentIndex: number, array: AutoscaleSettingResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: AutoscaleSettingResource
          • currentIndex: number
          • array: AutoscaleSettingResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AutoscaleSettingResource
  • reduceRight(callbackfn: function, initialValue: AutoscaleSettingResource): AutoscaleSettingResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AutoscaleSettingResource, currentValue: AutoscaleSettingResource, currentIndex: number, array: AutoscaleSettingResource[]): AutoscaleSettingResource
        • Parameters

          • previousValue: AutoscaleSettingResource
          • currentValue: AutoscaleSettingResource
          • currentIndex: number
          • array: AutoscaleSettingResource[]

          Returns AutoscaleSettingResource

    Returns AutoscaleSettingResource

  • Parameters

    • callbackfn: function
        • (previousValue: AutoscaleSettingResource, currentValue: AutoscaleSettingResource, currentIndex: number, array: AutoscaleSettingResource[]): AutoscaleSettingResource
        • Parameters

          • previousValue: AutoscaleSettingResource
          • currentValue: AutoscaleSettingResource
          • currentIndex: number
          • array: AutoscaleSettingResource[]

          Returns AutoscaleSettingResource

    • initialValue: AutoscaleSettingResource

    Returns AutoscaleSettingResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AutoscaleSettingResource, currentIndex: number, array: AutoscaleSettingResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: AutoscaleSettingResource
          • currentIndex: number
          • array: AutoscaleSettingResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AutoscaleSettingResource[]
  • Reverses the elements in an Array.

    Returns AutoscaleSettingResource[]

shift

  • shift(): AutoscaleSettingResource | undefined
  • Removes the first element from an array and returns it.

    Returns AutoscaleSettingResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AutoscaleSettingResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AutoscaleSettingResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AutoscaleSettingResource, index: number, array: AutoscaleSettingResource[]): boolean
        • Parameters

          • value: AutoscaleSettingResource
          • index: number
          • array: AutoscaleSettingResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AutoscaleSettingResource[]
  • splice(start: number, deleteCount: number, ...items: AutoscaleSettingResource[]): AutoscaleSettingResource[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AutoscaleSettingResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AutoscaleSettingResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns AutoscaleSettingResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AutoscaleSettingResource[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AutoscaleSettingResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AutoscaleSettingResource>
  • Returns an iterable of values in the array

    Returns IterableIterator<AutoscaleSettingResource>

type

type: object

className

className: string = "AutoscaleSettingResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutoscaleSettingResource"

name

name: "Composite" = "Composite"

Const AutoscaleSettingResourcePatch

AutoscaleSettingResourcePatch: object

The autoscale setting object for patch operations.

Optional enabled

enabled: undefined | false | true

the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'. Default value: true.

Optional name

name: undefined | string

the name of the autoscale setting.

Optional notifications

notifications: AutoscaleNotification[]

the collection of notifications.

profiles

profiles: AutoscaleProfile[]

the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

serializedName

serializedName: string = "AutoscaleSettingResourcePatch"

Optional tags

tags: undefined | object

Resource tags

Optional targetResourceUri

targetResourceUri: undefined | string

the resource identifier of the resource that the autoscale setting should be added to.

type

type: object

className

className: string = "AutoscaleSettingResourcePatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "properties.name"

type

type: object

name

name: "String" = "String"

notifications

notifications: object

serializedName

serializedName: string = "properties.notifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutoscaleNotification"

name

name: "Composite" = "Composite"

profiles

profiles: object

required

required: true = true

serializedName

serializedName: string = "properties.profiles"

constraints

constraints: object

MaxItems

MaxItems: number = 20

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutoscaleProfile"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

targetResourceUri

targetResourceUri: object

serializedName

serializedName: string = "properties.targetResourceUri"

type

type: object

name

name: "String" = "String"

Const AzNsActionGroup

AzNsActionGroup: object

Azure action group

Optional actionGroup

actionGroup: string[]

Azure Action Group reference.

Optional customWebhookPayload

customWebhookPayload: undefined | string

Custom payload to be sent for all webhook URI in Azure action group

Optional emailSubject

emailSubject: undefined | string

Custom subject override for all email ids in Azure action group

serializedName

serializedName: string = "AzNsActionGroup"

type

type: object

className

className: string = "AzNsActionGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionGroup

actionGroup: object

serializedName

serializedName: string = "actionGroup"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

customWebhookPayload

customWebhookPayload: object

serializedName

serializedName: string = "customWebhookPayload"

type

type: object

name

name: "String" = "String"

emailSubject

emailSubject: object

serializedName

serializedName: string = "emailSubject"

type

type: object

name

name: "String" = "String"

Const AzureAppPushReceiver

AzureAppPushReceiver: object

The Azure mobile App push notification receiver.

emailAddress

emailAddress: string

The email address registered for the Azure mobile app.

name

name: string

The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.

serializedName

serializedName: string = "AzureAppPushReceiver"

type

type: object

className

className: string = "AzureAppPushReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

emailAddress

emailAddress: object

required

required: true = true

serializedName

serializedName: string = "emailAddress"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const AzureFunctionReceiver

AzureFunctionReceiver: object

An azure function receiver.

functionAppResourceId

functionAppResourceId: string

The azure resource id of the function app.

functionName

functionName: string

The function name in the function app.

httpTriggerUrl

httpTriggerUrl: string

The http trigger url where http request sent to.

name

name: string

The name of the azure function receiver. Names must be unique across all receivers within an action group.

serializedName

serializedName: string = "AzureFunctionReceiver"

useCommonAlertSchema

useCommonAlertSchema: boolean

Indicates whether to use common alert schema.

type

type: object

className

className: string = "AzureFunctionReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

functionAppResourceId

functionAppResourceId: object

required

required: true = true

serializedName

serializedName: string = "functionAppResourceId"

type

type: object

name

name: "String" = "String"

functionName

functionName: object

required

required: true = true

serializedName

serializedName: string = "functionName"

type

type: object

name

name: "String" = "String"

httpTriggerUrl

httpTriggerUrl: object

required

required: true = true

serializedName

serializedName: string = "httpTriggerUrl"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

useCommonAlertSchema

useCommonAlertSchema: object

required

required: true = true

serializedName

serializedName: string = "useCommonAlertSchema"

type

type: object

name

name: "Boolean" = "Boolean"

Const Baseline

Baseline: object

The baseline values for a single sensitivity value.

highThresholds

highThresholds: number[]

The high thresholds of the baseline.

lowThresholds

lowThresholds: number[]

The low thresholds of the baseline.

sensitivity

sensitivity: Sensitivity

the sensitivity of the baseline. Possible values include: 'Low', 'Medium', 'High'

serializedName

serializedName: string = "Baseline"

type

type: object

className

className: string = "Baseline"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

highThresholds

highThresholds: object

required

required: true = true

serializedName

serializedName: string = "highThresholds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

lowThresholds

lowThresholds: object

required

required: true = true

serializedName

serializedName: string = "lowThresholds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

sensitivity

sensitivity: object

required

required: true = true

serializedName

serializedName: string = "sensitivity"

type

type: object

allowedValues

allowedValues: string[] = ["Low","Medium","High"]

name

name: "Enum" = "Enum"

Const BaselineMetadataValue

BaselineMetadataValue: object

Represents a baseline metadata value.

Optional name

the name of the metadata.

serializedName

serializedName: string = "BaselineMetadataValue"

Optional value

value: undefined | string

the value of the metadata.

type

type: object

className

className: string = "BaselineMetadataValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const BaselineResponse

BaselineResponse: object

The response to a baseline query.

Optional aggregation

aggregation: undefined | string

The aggregation type of the metric.

Optional baseline

baseline: Baseline[]

the baseline values for each sensitivity.

Optional id

id: undefined | string

the metric baseline Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional interval

interval: undefined | string

The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made.

Optional metadata

metadata: BaselineMetadataValue[]

the baseline metadata values.

Optional name

the name and the display name of the metric, i.e. it is localizable string. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BaselineResponse"

Optional timespan

timespan: undefined | string

The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested.

Optional timestamps

timestamps: Date[] | string[]

the array of timestamps of the baselines.

type

type: object

the resource type of the baseline resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "BaselineResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregation

aggregation: object

serializedName

serializedName: string = "properties.aggregation"

type

type: object

name

name: "String" = "String"

baseline

baseline: object

serializedName

serializedName: string = "properties.baseline"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Baseline"

name

name: "Composite" = "Composite"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "properties.interval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

metadata

metadata: object

serializedName

serializedName: string = "properties.metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BaselineMetadataValue"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

timespan

timespan: object

serializedName

serializedName: string = "properties.timespan"

type

type: object

name

name: "String" = "String"

timestamps

timestamps: object

serializedName

serializedName: string = "properties.timestamps"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const CalculateBaselineResponse

CalculateBaselineResponse: object

The response to a calculate baseline call.

baseline

baseline: Baseline[]

the baseline values for each sensitivity.

serializedName

serializedName: string = "CalculateBaselineResponse"

Optional timestamps

timestamps: Date[] | string[]

the array of timestamps of the baselines.

type

type: object

the resource type of the baseline resource.

className

className: string = "CalculateBaselineResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

baseline

baseline: object

required

required: true = true

serializedName

serializedName: string = "baseline"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Baseline"

name

name: "Composite" = "Composite"

timestamps

timestamps: object

serializedName

serializedName: string = "timestamps"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const Criteria

Criteria: object

Specifies the criteria for converting log to metric.

Optional dimensions

dimensions: Dimension[]

List of Dimensions for creating metric

metricName

metricName: string

Name of the metric

serializedName

serializedName: string = "Criteria"

type

type: object

className

className: string = "Criteria"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Dimension"

name

name: "Composite" = "Composite"

metricName

metricName: object

required

required: true = true

serializedName

serializedName: string = "metricName"

type

type: object

name

name: "String" = "String"

Const DataContainer

DataContainer: object

Information about a container with data for a given resource.

serializedName

serializedName: string = "DataContainer"

workspace

workspace: WorkspaceInfo

Log Analytics workspace information.

type

type: object

className

className: string = "DataContainer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

workspace

workspace: object

required

required: true = true

serializedName

serializedName: string = "workspace"

type

type: object

className

className: string = "WorkspaceInfo"

name

name: "Composite" = "Composite"

Const DiagnosticSettingsCategoryResource

DiagnosticSettingsCategoryResource: object

The diagnostic settings category resource.

Optional categoryType

categoryType: CategoryType

The type of the diagnostic settings category. Possible values include: 'Metrics', 'Logs'

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DiagnosticSettingsCategoryResource"

type

type: object

className

className: string = "DiagnosticSettingsCategoryResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

categoryType

categoryType: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.categoryType"

type

type: object

allowedValues

allowedValues: string[] = ["Metrics","Logs"]

name

name: "Enum" = "Enum"

Const DiagnosticSettingsCategoryResourceCollection

DiagnosticSettingsCategoryResourceCollection: object

Represents a collection of diagnostic setting category resources.

serializedName

serializedName: string = "DiagnosticSettingsCategoryResourceCollection"

Optional value

value: DiagnosticSettingsCategoryResource[]

The collection of diagnostic settings category resources.

type

type: object

className

className: string = "DiagnosticSettingsCategoryResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiagnosticSettingsCategoryResource"

name

name: "Composite" = "Composite"

Const DiagnosticSettingsResource

DiagnosticSettingsResource: object

The diagnostic setting resource.

Optional eventHubAuthorizationRuleId

eventHubAuthorizationRuleId: undefined | string

The resource Id for the event hub authorization rule.

Optional eventHubName

eventHubName: undefined | string

The name of the event hub. If none is specified, the default event hub will be selected.

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional logs

logs: LogSettings[]

the list of logs settings.

Optional metrics

metrics: MetricSettings[]

the list of metric settings.

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DiagnosticSettingsResource"

Optional serviceBusRuleId

serviceBusRuleId: undefined | string

The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.

Optional storageAccountId

storageAccountId: undefined | string

The resource ID of the storage account to which you would like to send Diagnostic Logs.

Optional workspaceId

workspaceId: undefined | string

The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

type

type: object

className

className: string = "DiagnosticSettingsResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eventHubAuthorizationRuleId

eventHubAuthorizationRuleId: object

serializedName

serializedName: string = "properties.eventHubAuthorizationRuleId"

type

type: object

name

name: "String" = "String"

eventHubName

eventHubName: object

serializedName

serializedName: string = "properties.eventHubName"

type

type: object

name

name: "String" = "String"

logs

logs: object

serializedName

serializedName: string = "properties.logs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LogSettings"

name

name: "Composite" = "Composite"

metrics

metrics: object

serializedName

serializedName: string = "properties.metrics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricSettings"

name

name: "Composite" = "Composite"

serviceBusRuleId

serviceBusRuleId: object

serializedName

serializedName: string = "properties.serviceBusRuleId"

type

type: object

name

name: "String" = "String"

storageAccountId

storageAccountId: object

serializedName

serializedName: string = "properties.storageAccountId"

type

type: object

name

name: "String" = "String"

workspaceId

workspaceId: object

serializedName

serializedName: string = "properties.workspaceId"

type

type: object

name

name: "String" = "String"

Const DiagnosticSettingsResourceCollection

DiagnosticSettingsResourceCollection: object

Represents a collection of alert rule resources.

serializedName

serializedName: string = "DiagnosticSettingsResourceCollection"

Optional value

value: DiagnosticSettingsResource[]

The collection of diagnostic settings resources;.

type

type: object

className

className: string = "DiagnosticSettingsResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiagnosticSettingsResource"

name

name: "Composite" = "Composite"

Const Dimension

Dimension: object

Specifies the criteria for converting log to metric.

name

name: string

Name of the dimension

serializedName

serializedName: string = "Dimension"

values

values: string[]

List of dimension values

type

type: object

className

className: string = "Dimension"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

operator

operator: object

defaultValue

defaultValue: string = "Include"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "operator"

type

type: object

name

name: "String" = "String"

values

values: object

required

required: true = true

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const EmailNotification

EmailNotification: object

Email notification of an autoscale event.

Optional customEmails

customEmails: string[]

the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored.

Optional sendToSubscriptionAdministrator

sendToSubscriptionAdministrator: undefined | false | true

a value indicating whether to send email to subscription administrator.

Optional sendToSubscriptionCoAdministrators

sendToSubscriptionCoAdministrators: undefined | false | true

a value indicating whether to send email to subscription co-administrators.

serializedName

serializedName: string = "EmailNotification"

type

type: object

className

className: string = "EmailNotification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customEmails

customEmails: object

serializedName

serializedName: string = "customEmails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sendToSubscriptionAdministrator

sendToSubscriptionAdministrator: object

serializedName

serializedName: string = "sendToSubscriptionAdministrator"

type

type: object

name

name: "Boolean" = "Boolean"

sendToSubscriptionCoAdministrators

sendToSubscriptionCoAdministrators: object

serializedName

serializedName: string = "sendToSubscriptionCoAdministrators"

type

type: object

name

name: "Boolean" = "Boolean"

Const EmailReceiver

EmailReceiver: object

An email receiver.

emailAddress

emailAddress: string

The email address of this receiver.

name

name: string

The name of the email receiver. Names must be unique across all receivers within an action group.

serializedName

serializedName: string = "EmailReceiver"

Optional status

The receiver status of the e-mail. Possible values include: 'NotSpecified', 'Enabled', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

useCommonAlertSchema

useCommonAlertSchema: boolean

Indicates whether to use common alert schema.

type

type: object

className

className: string = "EmailReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

emailAddress

emailAddress: object

required

required: true = true

serializedName

serializedName: string = "emailAddress"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","Enabled","Disabled"]

name

name: "Enum" = "Enum"

useCommonAlertSchema

useCommonAlertSchema: object

required

required: true = true

serializedName

serializedName: string = "useCommonAlertSchema"

type

type: object

name

name: "Boolean" = "Boolean"

Const EnableRequest

EnableRequest: object

Describes a receiver that should be resubscribed.

receiverName

receiverName: string

The name of the receiver to resubscribe.

serializedName

serializedName: string = "EnableRequest"

type

type: object

className

className: string = "EnableRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

receiverName

receiverName: object

required

required: true = true

serializedName

serializedName: string = "receiverName"

type

type: object

name

name: "String" = "String"

Const ErrorModel

ErrorModel: object

Error details.

code

code: string

Error code identifying the specific error.

Optional message

message: undefined | string

Error message in the caller's locale.

serializedName

serializedName: string = "Error"

type

type: object

className

className: string = "ErrorModel"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const ErrorResponse

ErrorResponse: object

Describes the format of Error response.

Optional code

code: undefined | string

Error code

Optional message

message: undefined | string

Error message indicating why the operation failed.

serializedName

serializedName: string = "ErrorResponse"

type

type: object

className

className: string = "ErrorResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const EventCategoryCollection

EventCategoryCollection: object
interface

A collection of event categories. Currently possible values are: Administrative, Security, ServiceHealth, Alert, Recommendation, Policy.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "EventCategoryCollection"

__@iterator

  • __@iterator(): IterableIterator<LocalizableString>
  • Iterator

    Returns IterableIterator<LocalizableString>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LocalizableString>[]): LocalizableString[]
  • concat(...items: (T | ConcatArray<T>)[]): LocalizableString[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LocalizableString>[]

      Additional items to add to the end of array1.

    Returns LocalizableString[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LocalizableString[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LocalizableString]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LocalizableString]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LocalizableString, index: number, array: LocalizableString[]): boolean
        • Parameters

          • value: LocalizableString
          • index: number
          • array: LocalizableString[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LocalizableString, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LocalizableString

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LocalizableString[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LocalizableString

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LocalizableString, index: number, array: LocalizableString[]): boolean
        • Parameters

          • value: LocalizableString
          • index: number
          • array: LocalizableString[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LocalizableString, index: number, array: LocalizableString[]): any
        • Parameters

          • value: LocalizableString
          • index: number
          • array: LocalizableString[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LocalizableString[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LocalizableString | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LocalizableString

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LocalizableString, index: number, obj: LocalizableString[]): boolean
        • Parameters

          • this: void
          • value: LocalizableString
          • index: number
          • obj: LocalizableString[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LocalizableString, index: number, obj: LocalizableString[]): boolean
        • Parameters

          • value: LocalizableString
          • index: number
          • obj: LocalizableString[]

          Returns boolean

    • Optional thisArg: any

    Returns LocalizableString | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LocalizableString, index: number, obj: LocalizableString[]): boolean
        • Parameters

          • value: LocalizableString
          • index: number
          • obj: LocalizableString[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LocalizableString, index: number, array: LocalizableString[]): void
        • Parameters

          • value: LocalizableString
          • index: number
          • array: LocalizableString[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LocalizableString, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LocalizableString

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LocalizableString, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LocalizableString

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LocalizableString, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LocalizableString

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LocalizableString, index: number, array: LocalizableString[]): U
        • Parameters

          • value: LocalizableString
          • index: number
          • array: LocalizableString[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LocalizableString | undefined
  • Removes the last element from an array and returns it.

    Returns LocalizableString | undefined

push

  • push(...items: LocalizableString[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LocalizableString[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LocalizableString
  • reduce(callbackfn: function, initialValue: LocalizableString): LocalizableString
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LocalizableString, currentValue: LocalizableString, currentIndex: number, array: LocalizableString[]): LocalizableString
        • Parameters

          • previousValue: LocalizableString
          • currentValue: LocalizableString
          • currentIndex: number
          • array: LocalizableString[]

          Returns LocalizableString

    Returns LocalizableString

  • Parameters

    • callbackfn: function
        • (previousValue: LocalizableString, currentValue: LocalizableString, currentIndex: number, array: LocalizableString[]): LocalizableString
        • Parameters

          • previousValue: LocalizableString
          • currentValue: LocalizableString
          • currentIndex: number
          • array: LocalizableString[]

          Returns LocalizableString

    • initialValue: LocalizableString

    Returns LocalizableString

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LocalizableString, currentIndex: number, array: LocalizableString[]): U
        • Parameters

          • previousValue: U
          • currentValue: LocalizableString
          • currentIndex: number
          • array: LocalizableString[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LocalizableString
  • reduceRight(callbackfn: function, initialValue: LocalizableString): LocalizableString
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LocalizableString, currentValue: LocalizableString, currentIndex: number, array: LocalizableString[]): LocalizableString
        • Parameters

          • previousValue: LocalizableString
          • currentValue: LocalizableString
          • currentIndex: number
          • array: LocalizableString[]

          Returns LocalizableString

    Returns LocalizableString

  • Parameters

    • callbackfn: function
        • (previousValue: LocalizableString, currentValue: LocalizableString, currentIndex: number, array: LocalizableString[]): LocalizableString
        • Parameters

          • previousValue: LocalizableString
          • currentValue: LocalizableString
          • currentIndex: number
          • array: LocalizableString[]

          Returns LocalizableString

    • initialValue: LocalizableString

    Returns LocalizableString

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LocalizableString, currentIndex: number, array: LocalizableString[]): U
        • Parameters

          • previousValue: U
          • currentValue: LocalizableString
          • currentIndex: number
          • array: LocalizableString[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LocalizableString[]
  • Reverses the elements in an Array.

    Returns LocalizableString[]

shift

  • shift(): LocalizableString | undefined
  • Removes the first element from an array and returns it.

    Returns LocalizableString | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LocalizableString[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LocalizableString[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LocalizableString, index: number, array: LocalizableString[]): boolean
        • Parameters

          • value: LocalizableString
          • index: number
          • array: LocalizableString[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LocalizableString[]
  • splice(start: number, deleteCount: number, ...items: LocalizableString[]): LocalizableString[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LocalizableString[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LocalizableString[]

      Elements to insert into the array in place of the deleted elements.

    Returns LocalizableString[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LocalizableString[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LocalizableString[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LocalizableString>
  • Returns an iterable of values in the array

    Returns IterableIterator<LocalizableString>

type

type: object

className

className: string = "EventCategoryCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

Const EventData

EventData: object

The Azure event log entries are of type EventData

Optional authorization

authorization: SenderAuthorization

The sender authorization information. NOTE: This property will not be serialized. It can only be populated by the server.

Optional caller

caller: undefined | string

the email address of the user who has performed the operation, the UPN claim or SPN claim based on availability. NOTE: This property will not be serialized. It can only be populated by the server.

Optional category

the event category. NOTE: This property will not be serialized. It can only be populated by the server.

Optional claims

claims: undefined | object

key value pairs to identify ARM permissions. NOTE: This property will not be serialized. It can only be populated by the server.

Optional correlationId

correlationId: undefined | string

the correlation Id, usually a GUID in the string format. The correlation Id is shared among the events that belong to the same uber operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

the description of the event. NOTE: This property will not be serialized. It can only be populated by the server.

Optional eventDataId

eventDataId: undefined | string

the event data Id. This is a unique identifier for an event. NOTE: This property will not be serialized. It can only be populated by the server.

Optional eventName

the event name. This value should not be confused with OperationName. For practical purposes, OperationName might be more appealing to end users. NOTE: This property will not be serialized. It can only be populated by the server.

Optional eventTimestamp

eventTimestamp: Date

the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional httpRequest

httpRequest: HttpRequestInfo

the HTTP request info. Usually includes the 'clientRequestId', 'clientIpAddress' (IP address of the user who initiated the event) and 'method' (HTTP method e.g. PUT). NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

the Id of this event as required by ARM for RBAC. It contains the EventDataID and a timestamp information. NOTE: This property will not be serialized. It can only be populated by the server.

Optional level

level: EventLevel

the event level. Possible values include: 'Critical', 'Error', 'Warning', 'Informational', 'Verbose' NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationId

operationId: undefined | string

It is usually a GUID shared among the events corresponding to single operation. This value should not be confused with EventName. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationName

operationName: LocalizableString

the operation name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

the set of <Key, Value> pairs (usually a Dictionary<String, String>) that includes details about the event. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGroupName

resourceGroupName: undefined | string

the resource group name of the impacted resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceId

resourceId: undefined | string

the resource uri that uniquely identifies the resource that caused this event. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceProviderName

resourceProviderName: LocalizableString

the resource provider name of the impacted resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceType

resourceType: LocalizableString

the resource type NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EventData"

Optional status

a string describing the status of the operation. Some typical values are: Started, In progress, Succeeded, Failed, Resolved. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subStatus

the event sub status. Most of the time, when included, this captures the HTTP status code of the REST call. Common values are: OK (HTTP Status Code: 200), Created (HTTP Status Code: 201), Accepted (HTTP Status Code: 202), No Content (HTTP Status Code: 204), Bad Request(HTTP Status Code: 400), Not Found (HTTP Status Code: 404), Conflict (HTTP Status Code: 409), Internal Server Error (HTTP Status Code: 500), Service Unavailable (HTTP Status Code:503), Gateway Timeout (HTTP Status Code: 504) NOTE: This property will not be serialized. It can only be populated by the server.

Optional submissionTimestamp

submissionTimestamp: Date

the timestamp of when the event became available for querying via this API. It is in ISO 8601 format. This value should not be confused eventTimestamp. As there might be a delay between the occurrence time of the event, and the time that the event is submitted to the Azure logging infrastructure. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscriptionId

subscriptionId: undefined | string

the Azure subscription Id usually a GUID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string

the Azure tenant Id NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "EventData"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorization

authorization: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "SenderAuthorization"

name

name: "Composite" = "Composite"

caller

caller: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "caller"

type

type: object

name

name: "String" = "String"

category

category: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "category"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

claims

claims: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "claims"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

correlationId

correlationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "correlationId"

type

type: object

name

name: "String" = "String"

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

eventDataId

eventDataId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "eventDataId"

type

type: object

name

name: "String" = "String"

eventName

eventName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "eventName"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

eventTimestamp

eventTimestamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "eventTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

httpRequest

httpRequest: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "httpRequest"

type

type: object

className

className: string = "HttpRequestInfo"

name

name: "Composite" = "Composite"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

level

level: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "level"

type

type: object

allowedValues

allowedValues: string[] = ["Critical","Error","Warning","Informational","Verbose"]

name

name: "Enum" = "Enum"

operationId

operationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: "String" = "String"

operationName

operationName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "operationName"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

properties

properties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

resourceGroupName

resourceGroupName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

resourceProviderName

resourceProviderName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceProviderName"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

resourceType

resourceType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceType"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

subStatus

subStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "subStatus"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

submissionTimestamp

submissionTimestamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "submissionTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

subscriptionId

subscriptionId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

Const EventDataCollection

EventDataCollection: object
interface

Represents collection of events.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Provides the link to retrieve the next set of events.

serializedName

serializedName: string = "EventDataCollection"

__@iterator

  • __@iterator(): IterableIterator<EventData>
  • Iterator

    Returns IterableIterator<EventData>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<EventData>[]): EventData[]
  • concat(...items: (T | ConcatArray<T>)[]): EventData[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<EventData>[]

      Additional items to add to the end of array1.

    Returns EventData[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns EventData[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, EventData]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, EventData]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: EventData, index: number, array: EventData[]): boolean
        • Parameters

          • value: EventData
          • index: number
          • array: EventData[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: EventData, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: EventData

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): EventData[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: EventData

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: EventData, index: number, array: EventData[]): boolean
        • Parameters

          • value: EventData
          • index: number
          • array: EventData[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: EventData, index: number, array: EventData[]): any
        • Parameters

          • value: EventData
          • index: number
          • array: EventData[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns EventData[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): EventData | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: EventData

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: EventData, index: number, obj: EventData[]): boolean
        • Parameters

          • this: void
          • value: EventData
          • index: number
          • obj: EventData[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: EventData, index: number, obj: EventData[]): boolean
        • Parameters

          • value: EventData
          • index: number
          • obj: EventData[]

          Returns boolean

    • Optional thisArg: any

    Returns EventData | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: EventData, index: number, obj: EventData[]): boolean
        • Parameters

          • value: EventData
          • index: number
          • obj: EventData[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: EventData, index: number, array: EventData[]): void
        • Parameters

          • value: EventData
          • index: number
          • array: EventData[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: EventData, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: EventData

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: EventData, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: EventData

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: EventData, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: EventData

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: EventData, index: number, array: EventData[]): U
        • Parameters

          • value: EventData
          • index: number
          • array: EventData[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): EventData | undefined
  • Removes the last element from an array and returns it.

    Returns EventData | undefined

push

  • push(...items: EventData[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: EventData[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): EventData
  • reduce(callbackfn: function, initialValue: EventData): EventData
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: EventData, currentValue: EventData, currentIndex: number, array: EventData[]): EventData
        • Parameters

          • previousValue: EventData
          • currentValue: EventData
          • currentIndex: number
          • array: EventData[]

          Returns EventData

    Returns EventData

  • Parameters

    • callbackfn: function
        • (previousValue: EventData, currentValue: EventData, currentIndex: number, array: EventData[]): EventData
        • Parameters

          • previousValue: EventData
          • currentValue: EventData
          • currentIndex: number
          • array: EventData[]

          Returns EventData

    • initialValue: EventData

    Returns EventData

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: EventData, currentIndex: number, array: EventData[]): U
        • Parameters

          • previousValue: U
          • currentValue: EventData
          • currentIndex: number
          • array: EventData[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): EventData
  • reduceRight(callbackfn: function, initialValue: EventData): EventData
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: EventData, currentValue: EventData, currentIndex: number, array: EventData[]): EventData
        • Parameters

          • previousValue: EventData
          • currentValue: EventData
          • currentIndex: number
          • array: EventData[]

          Returns EventData

    Returns EventData

  • Parameters

    • callbackfn: function
        • (previousValue: EventData, currentValue: EventData, currentIndex: number, array: EventData[]): EventData
        • Parameters

          • previousValue: EventData
          • currentValue: EventData
          • currentIndex: number
          • array: EventData[]

          Returns EventData

    • initialValue: EventData

    Returns EventData

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: EventData, currentIndex: number, array: EventData[]): U
        • Parameters

          • previousValue: U
          • currentValue: EventData
          • currentIndex: number
          • array: EventData[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): EventData[]
  • Reverses the elements in an Array.

    Returns EventData[]

shift

  • shift(): EventData | undefined
  • Removes the first element from an array and returns it.

    Returns EventData | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): EventData[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns EventData[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: EventData, index: number, array: EventData[]): boolean
        • Parameters

          • value: EventData
          • index: number
          • array: EventData[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): EventData[]
  • splice(start: number, deleteCount: number, ...items: EventData[]): EventData[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns EventData[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: EventData[]

      Elements to insert into the array in place of the deleted elements.

    Returns EventData[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: EventData[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: EventData[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<EventData>
  • Returns an iterable of values in the array

    Returns IterableIterator<EventData>

type

type: object

className

className: string = "EventDataCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EventData"

name

name: "Composite" = "Composite"

Const HttpRequestInfo

HttpRequestInfo: object

The Http request info.

Optional clientIpAddress

clientIpAddress: undefined | string

the client Ip Address

Optional clientRequestId

clientRequestId: undefined | string

the client request id.

Optional method

method: undefined | string

the Http request method.

serializedName

serializedName: string = "HttpRequestInfo"

Optional uri

uri: undefined | string

the Uri.

type

type: object

className

className: string = "HttpRequestInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientIpAddress

clientIpAddress: object

serializedName

serializedName: string = "clientIpAddress"

type

type: object

name

name: "String" = "String"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

name: "String" = "String"

method

method: object

serializedName

serializedName: string = "method"

type

type: object

name

name: "String" = "String"

uri

uri: object

serializedName

serializedName: string = "uri"

type

type: object

name

name: "String" = "String"

Const Incident

Incident: object

An alert incident indicates the activation status of an alert rule.

Optional activatedTime

activatedTime: Date

The time at which the incident was activated in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isActive

isActive: undefined | false | true

A boolean to indicate whether the incident is active or resolved. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Incident name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resolvedTime

resolvedTime: Date

The time at which the incident was resolved in ISO8601 format. If null, it means the incident is still active. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ruleName

ruleName: undefined | string

Rule name that is associated with the incident. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Incident"

type

type: object

className

className: string = "Incident"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activatedTime

activatedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "activatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

isActive

isActive: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "isActive"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

resolvedTime

resolvedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resolvedTime"

type

type: object

name

name: "DateTime" = "DateTime"

ruleName

ruleName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "ruleName"

type

type: object

name

name: "String" = "String"

Const IncidentListResult

IncidentListResult: object
interface

The List incidents operation response.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "IncidentListResult"

__@iterator

  • __@iterator(): IterableIterator<Incident>
  • Iterator

    Returns IterableIterator<Incident>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Incident>[]): Incident[]
  • concat(...items: (T | ConcatArray<T>)[]): Incident[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Incident>[]

      Additional items to add to the end of array1.

    Returns Incident[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Incident[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Incident]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Incident]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Incident, index: number, array: Incident[]): boolean
        • Parameters

          • value: Incident
          • index: number
          • array: Incident[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Incident, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Incident

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Incident[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Incident

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Incident, index: number, array: Incident[]): boolean
        • Parameters

          • value: Incident
          • index: number
          • array: Incident[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Incident, index: number, array: Incident[]): any
        • Parameters

          • value: Incident
          • index: number
          • array: Incident[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Incident[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Incident | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Incident

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Incident, index: number, obj: Incident[]): boolean
        • Parameters

          • this: void
          • value: Incident
          • index: number
          • obj: Incident[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Incident, index: number, obj: Incident[]): boolean
        • Parameters

          • value: Incident
          • index: number
          • obj: Incident[]

          Returns boolean

    • Optional thisArg: any

    Returns Incident | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Incident, index: number, obj: Incident[]): boolean
        • Parameters

          • value: Incident
          • index: number
          • obj: Incident[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Incident, index: number, array: Incident[]): void
        • Parameters

          • value: Incident
          • index: number
          • array: Incident[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Incident, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Incident

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Incident, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Incident

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Incident, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Incident

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Incident, index: number, array: Incident[]): U
        • Parameters

          • value: Incident
          • index: number
          • array: Incident[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Incident | undefined
  • Removes the last element from an array and returns it.

    Returns Incident | undefined

push

  • push(...items: Incident[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Incident[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Incident
  • reduce(callbackfn: function, initialValue: Incident): Incident
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Incident, currentValue: Incident, currentIndex: number, array: Incident[]): Incident
        • Parameters

          • previousValue: Incident
          • currentValue: Incident
          • currentIndex: number
          • array: Incident[]

          Returns Incident

    Returns Incident

  • Parameters

    • callbackfn: function
        • (previousValue: Incident, currentValue: Incident, currentIndex: number, array: Incident[]): Incident
        • Parameters

          • previousValue: Incident
          • currentValue: Incident
          • currentIndex: number
          • array: Incident[]

          Returns Incident

    • initialValue: Incident

    Returns Incident

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Incident, currentIndex: number, array: Incident[]): U
        • Parameters

          • previousValue: U
          • currentValue: Incident
          • currentIndex: number
          • array: Incident[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Incident
  • reduceRight(callbackfn: function, initialValue: Incident): Incident
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Incident, currentValue: Incident, currentIndex: number, array: Incident[]): Incident
        • Parameters

          • previousValue: Incident
          • currentValue: Incident
          • currentIndex: number
          • array: Incident[]

          Returns Incident

    Returns Incident

  • Parameters

    • callbackfn: function
        • (previousValue: Incident, currentValue: Incident, currentIndex: number, array: Incident[]): Incident
        • Parameters

          • previousValue: Incident
          • currentValue: Incident
          • currentIndex: number
          • array: Incident[]

          Returns Incident

    • initialValue: Incident

    Returns Incident

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Incident, currentIndex: number, array: Incident[]): U
        • Parameters

          • previousValue: U
          • currentValue: Incident
          • currentIndex: number
          • array: Incident[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Incident[]
  • Reverses the elements in an Array.

    Returns Incident[]

shift

  • shift(): Incident | undefined
  • Removes the first element from an array and returns it.

    Returns Incident | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Incident[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Incident[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Incident, index: number, array: Incident[]): boolean
        • Parameters

          • value: Incident
          • index: number
          • array: Incident[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Incident[]
  • splice(start: number, deleteCount: number, ...items: Incident[]): Incident[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Incident[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Incident[]

      Elements to insert into the array in place of the deleted elements.

    Returns Incident[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Incident[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Incident[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Incident>
  • Returns an iterable of values in the array

    Returns IterableIterator<Incident>

type

type: object

className

className: string = "IncidentListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Incident"

name

name: "Composite" = "Composite"

Const ItsmReceiver

ItsmReceiver: object

An Itsm receiver.

connectionId

connectionId: string

Unique identification of ITSM connection among multiple defined in above workspace.

name

name: string

The name of the Itsm receiver. Names must be unique across all receivers within an action group.

region

region: string

Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'

serializedName

serializedName: string = "ItsmReceiver"

ticketConfiguration

ticketConfiguration: string

JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.

workspaceId

workspaceId: string

OMS LA instance identifier.

type

type: object

className

className: string = "ItsmReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionId

connectionId: object

required

required: true = true

serializedName

serializedName: string = "connectionId"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

region

region: object

required

required: true = true

serializedName

serializedName: string = "region"

type

type: object

name

name: "String" = "String"

ticketConfiguration

ticketConfiguration: object

required

required: true = true

serializedName

serializedName: string = "ticketConfiguration"

type

type: object

name

name: "String" = "String"

workspaceId

workspaceId: object

required

required: true = true

serializedName

serializedName: string = "workspaceId"

type

type: object

name

name: "String" = "String"

Const LocalizableString

LocalizableString: object

The localizable string class.

Optional localizedValue

localizedValue: undefined | string

the locale specific value.

serializedName

serializedName: string = "LocalizableString"

value

value: string

the invariant value.

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const LocationThresholdRuleCondition

LocationThresholdRuleCondition: object

A rule condition based on a certain number of locations failing.

Optional dataSource

the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

failedLocationCount

failedLocationCount: number

the number of locations that must fail to activate the alert.

odatatype

odatatype: "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition"

Polymorphic Discriminator

serializedName

serializedName: string = "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition"

Optional windowSize

windowSize: undefined | string

the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.

type

type: object

className

className: string = "LocationThresholdRuleCondition"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RuleCondition.type.polymorphicDiscriminator

uberParent

uberParent: string = "RuleCondition"

modelProperties

modelProperties: object

failedLocationCount

failedLocationCount: object

required

required: true = true

serializedName

serializedName: string = "failedLocationCount"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

windowSize

windowSize: object

serializedName

serializedName: string = "windowSize"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const LogMetricTrigger

LogMetricTrigger: object

A log metrics trigger descriptor.

Optional metricColumn

metricColumn: undefined | string

Evaluation of metric on a particular column

Optional metricTriggerType

metricTriggerType: MetricTriggerType

Metric Trigger Type - 'Consecutive' or 'Total'. Possible values include: 'Consecutive', 'Total'

serializedName

serializedName: string = "LogMetricTrigger"

Optional threshold

threshold: undefined | number

The threshold of the metric trigger.

Optional thresholdOperator

thresholdOperator: ConditionalOperator

Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'. Possible values include: 'GreaterThan', 'LessThan', 'Equal'

type

type: object

className

className: string = "LogMetricTrigger"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metricColumn

metricColumn: object

serializedName

serializedName: string = "metricColumn"

type

type: object

name

name: "String" = "String"

metricTriggerType

metricTriggerType: object

serializedName

serializedName: string = "metricTriggerType"

type

type: object

name

name: "String" = "String"

threshold

threshold: object

serializedName

serializedName: string = "threshold"

type

type: object

name

name: "Number" = "Number"

thresholdOperator

thresholdOperator: object

serializedName

serializedName: string = "thresholdOperator"

type

type: object

name

name: "String" = "String"

Const LogProfileCollection

LogProfileCollection: object
interface

Represents a collection of log profiles.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "LogProfileCollection"

__@iterator

  • __@iterator(): IterableIterator<LogProfileResource>
  • Iterator

    Returns IterableIterator<LogProfileResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LogProfileResource>[]): LogProfileResource[]
  • concat(...items: (T | ConcatArray<T>)[]): LogProfileResource[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LogProfileResource>[]

      Additional items to add to the end of array1.

    Returns LogProfileResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LogProfileResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LogProfileResource]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LogProfileResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LogProfileResource, index: number, array: LogProfileResource[]): boolean
        • Parameters

          • value: LogProfileResource
          • index: number
          • array: LogProfileResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LogProfileResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LogProfileResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LogProfileResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LogProfileResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LogProfileResource, index: number, array: LogProfileResource[]): boolean
        • Parameters

          • value: LogProfileResource
          • index: number
          • array: LogProfileResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LogProfileResource, index: number, array: LogProfileResource[]): any
        • Parameters

          • value: LogProfileResource
          • index: number
          • array: LogProfileResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LogProfileResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LogProfileResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LogProfileResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LogProfileResource, index: number, obj: LogProfileResource[]): boolean
        • Parameters

          • this: void
          • value: LogProfileResource
          • index: number
          • obj: LogProfileResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LogProfileResource, index: number, obj: LogProfileResource[]): boolean
        • Parameters

          • value: LogProfileResource
          • index: number
          • obj: LogProfileResource[]

          Returns boolean

    • Optional thisArg: any

    Returns LogProfileResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LogProfileResource, index: number, obj: LogProfileResource[]): boolean
        • Parameters

          • value: LogProfileResource
          • index: number
          • obj: LogProfileResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LogProfileResource, index: number, array: LogProfileResource[]): void
        • Parameters

          • value: LogProfileResource
          • index: number
          • array: LogProfileResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LogProfileResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LogProfileResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LogProfileResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LogProfileResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LogProfileResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LogProfileResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LogProfileResource, index: number, array: LogProfileResource[]): U
        • Parameters

          • value: LogProfileResource
          • index: number
          • array: LogProfileResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LogProfileResource | undefined
  • Removes the last element from an array and returns it.

    Returns LogProfileResource | undefined

push

  • push(...items: LogProfileResource[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LogProfileResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LogProfileResource
  • reduce(callbackfn: function, initialValue: LogProfileResource): LogProfileResource
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LogProfileResource, currentValue: LogProfileResource, currentIndex: number, array: LogProfileResource[]): LogProfileResource
        • Parameters

          • previousValue: LogProfileResource
          • currentValue: LogProfileResource
          • currentIndex: number
          • array: LogProfileResource[]

          Returns LogProfileResource

    Returns LogProfileResource

  • Parameters

    • callbackfn: function
        • (previousValue: LogProfileResource, currentValue: LogProfileResource, currentIndex: number, array: LogProfileResource[]): LogProfileResource
        • Parameters

          • previousValue: LogProfileResource
          • currentValue: LogProfileResource
          • currentIndex: number
          • array: LogProfileResource[]

          Returns LogProfileResource

    • initialValue: LogProfileResource

    Returns LogProfileResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LogProfileResource, currentIndex: number, array: LogProfileResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: LogProfileResource
          • currentIndex: number
          • array: LogProfileResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LogProfileResource
  • reduceRight(callbackfn: function, initialValue: LogProfileResource): LogProfileResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LogProfileResource, currentValue: LogProfileResource, currentIndex: number, array: LogProfileResource[]): LogProfileResource
        • Parameters

          • previousValue: LogProfileResource
          • currentValue: LogProfileResource
          • currentIndex: number
          • array: LogProfileResource[]

          Returns LogProfileResource

    Returns LogProfileResource

  • Parameters

    • callbackfn: function
        • (previousValue: LogProfileResource, currentValue: LogProfileResource, currentIndex: number, array: LogProfileResource[]): LogProfileResource
        • Parameters

          • previousValue: LogProfileResource
          • currentValue: LogProfileResource
          • currentIndex: number
          • array: LogProfileResource[]

          Returns LogProfileResource

    • initialValue: LogProfileResource

    Returns LogProfileResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LogProfileResource, currentIndex: number, array: LogProfileResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: LogProfileResource
          • currentIndex: number
          • array: LogProfileResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LogProfileResource[]
  • Reverses the elements in an Array.

    Returns LogProfileResource[]

shift

  • shift(): LogProfileResource | undefined
  • Removes the first element from an array and returns it.

    Returns LogProfileResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LogProfileResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LogProfileResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LogProfileResource, index: number, array: LogProfileResource[]): boolean
        • Parameters

          • value: LogProfileResource
          • index: number
          • array: LogProfileResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LogProfileResource[]
  • splice(start: number, deleteCount: number, ...items: LogProfileResource[]): LogProfileResource[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LogProfileResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LogProfileResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns LogProfileResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LogProfileResource[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LogProfileResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LogProfileResource>
  • Returns an iterable of values in the array

    Returns IterableIterator<LogProfileResource>

type

type: object

className

className: string = "LogProfileCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LogProfileResource"

name

name: "Composite" = "Composite"

Const LogProfileResource

LogProfileResource: object

The log profile resource.

categories

categories: string[]

the categories of the logs. These categories are created as is convenient to the user. Some values are: 'Write', 'Delete', and/or 'Action.'

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

locations

locations: string[]

List of regions for which Activity Log events should be stored or streamed. It is a comma separated list of valid ARM locations including the 'global' location.

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

retentionPolicy

retentionPolicy: RetentionPolicy

the retention policy for the events in the log.

serializedName

serializedName: string = "LogProfileResource"

Optional serviceBusRuleId

serviceBusRuleId: undefined | string

The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'.

Optional storageAccountId

storageAccountId: undefined | string

the resource id of the storage account to which you would like to send the Activity Log.

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "LogProfileResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

categories

categories: object

required

required: true = true

serializedName

serializedName: string = "properties.categories"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

locations

locations: object

required

required: true = true

serializedName

serializedName: string = "properties.locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

retentionPolicy

retentionPolicy: object

required

required: true = true

serializedName

serializedName: string = "properties.retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

serviceBusRuleId

serviceBusRuleId: object

serializedName

serializedName: string = "properties.serviceBusRuleId"

type

type: object

name

name: "String" = "String"

storageAccountId

storageAccountId: object

serializedName

serializedName: string = "properties.storageAccountId"

type

type: object

name

name: "String" = "String"

Const LogProfileResourcePatch

LogProfileResourcePatch: object

The log profile resource for patch operations.

categories

categories: string[]

the categories of the logs. These categories are created as is convenient to the user. Some values are: 'Write', 'Delete', and/or 'Action.'

locations

locations: string[]

List of regions for which Activity Log events should be stored or streamed. It is a comma separated list of valid ARM locations including the 'global' location.

retentionPolicy

retentionPolicy: RetentionPolicy

the retention policy for the events in the log.

serializedName

serializedName: string = "LogProfileResourcePatch"

Optional serviceBusRuleId

serviceBusRuleId: undefined | string

The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'.

Optional storageAccountId

storageAccountId: undefined | string

the resource id of the storage account to which you would like to send the Activity Log.

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "LogProfileResourcePatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

categories

categories: object

required

required: true = true

serializedName

serializedName: string = "properties.categories"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

locations

locations: object

required

required: true = true

serializedName

serializedName: string = "properties.locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

retentionPolicy

retentionPolicy: object

required

required: true = true

serializedName

serializedName: string = "properties.retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

serviceBusRuleId

serviceBusRuleId: object

serializedName

serializedName: string = "properties.serviceBusRuleId"

type

type: object

name

name: "String" = "String"

storageAccountId

storageAccountId: object

serializedName

serializedName: string = "properties.storageAccountId"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const LogSearchRuleResource

LogSearchRuleResource: object

The Log Search Rule resource.

action

action: ActionUnion

Action needs to be taken on rule execution.

Optional description

description: undefined | string

The description of the Log Search rule.

Optional enabled

enabled: Enabled

The flag which indicates whether the Log Search rule is enabled. Value should be true or false. Possible values include: 'true', 'false'

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastUpdatedTime

lastUpdatedTime: Date

Last time the rule was updated in IS08601 format. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

Provisioning state of the scheduled query rule. Possible values include: 'Succeeded', 'Deploying', 'Canceled', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional schedule

schedule: Schedule

Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction

serializedName

serializedName: string = "LogSearchRuleResource"

source

source: Source

Data Source against which rule will Query Data

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "LogSearchRuleResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

required

required: true = true

serializedName

serializedName: string = "properties.action"

type

type: object

className

className: string = "Action"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "String" = "String"

lastUpdatedTime

lastUpdatedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastUpdatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

schedule

schedule: object

serializedName

serializedName: string = "properties.schedule"

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

source

source: object

required

required: true = true

serializedName

serializedName: string = "properties.source"

type

type: object

className

className: string = "Source"

name

name: "Composite" = "Composite"

Const LogSearchRuleResourceCollection

LogSearchRuleResourceCollection: object
interface

Represents a collection of Log Search rule resources.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "LogSearchRuleResourceCollection"

__@iterator

  • __@iterator(): IterableIterator<LogSearchRuleResource>
  • Iterator

    Returns IterableIterator<LogSearchRuleResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LogSearchRuleResource>[]): LogSearchRuleResource[]
  • concat(...items: (T | ConcatArray<T>)[]): LogSearchRuleResource[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LogSearchRuleResource>[]

      Additional items to add to the end of array1.

    Returns LogSearchRuleResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LogSearchRuleResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LogSearchRuleResource]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LogSearchRuleResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LogSearchRuleResource, index: number, array: LogSearchRuleResource[]): boolean
        • Parameters

          • value: LogSearchRuleResource
          • index: number
          • array: LogSearchRuleResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LogSearchRuleResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LogSearchRuleResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LogSearchRuleResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LogSearchRuleResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LogSearchRuleResource, index: number, array: LogSearchRuleResource[]): boolean
        • Parameters

          • value: LogSearchRuleResource
          • index: number
          • array: LogSearchRuleResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LogSearchRuleResource, index: number, array: LogSearchRuleResource[]): any
        • Parameters

          • value: LogSearchRuleResource
          • index: number
          • array: LogSearchRuleResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LogSearchRuleResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LogSearchRuleResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LogSearchRuleResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LogSearchRuleResource, index: number, obj: LogSearchRuleResource[]): boolean
        • Parameters

          • this: void
          • value: LogSearchRuleResource
          • index: number
          • obj: LogSearchRuleResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LogSearchRuleResource, index: number, obj: LogSearchRuleResource[]): boolean
        • Parameters

          • value: LogSearchRuleResource
          • index: number
          • obj: LogSearchRuleResource[]

          Returns boolean

    • Optional thisArg: any

    Returns LogSearchRuleResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LogSearchRuleResource, index: number, obj: LogSearchRuleResource[]): boolean
        • Parameters

          • value: LogSearchRuleResource
          • index: number
          • obj: LogSearchRuleResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LogSearchRuleResource, index: number, array: LogSearchRuleResource[]): void
        • Parameters

          • value: LogSearchRuleResource
          • index: number
          • array: LogSearchRuleResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LogSearchRuleResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LogSearchRuleResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LogSearchRuleResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LogSearchRuleResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LogSearchRuleResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LogSearchRuleResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LogSearchRuleResource, index: number, array: LogSearchRuleResource[]): U
        • Parameters

          • value: LogSearchRuleResource
          • index: number
          • array: LogSearchRuleResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LogSearchRuleResource | undefined
  • Removes the last element from an array and returns it.

    Returns LogSearchRuleResource | undefined

push

  • push(...items: LogSearchRuleResource[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LogSearchRuleResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LogSearchRuleResource
  • reduce(callbackfn: function, initialValue: LogSearchRuleResource): LogSearchRuleResource
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LogSearchRuleResource, currentValue: LogSearchRuleResource, currentIndex: number, array: LogSearchRuleResource[]): LogSearchRuleResource
        • Parameters

          • previousValue: LogSearchRuleResource
          • currentValue: LogSearchRuleResource
          • currentIndex: number
          • array: LogSearchRuleResource[]

          Returns LogSearchRuleResource

    Returns LogSearchRuleResource

  • Parameters

    • callbackfn: function
        • (previousValue: LogSearchRuleResource, currentValue: LogSearchRuleResource, currentIndex: number, array: LogSearchRuleResource[]): LogSearchRuleResource
        • Parameters

          • previousValue: LogSearchRuleResource
          • currentValue: LogSearchRuleResource
          • currentIndex: number
          • array: LogSearchRuleResource[]

          Returns LogSearchRuleResource

    • initialValue: LogSearchRuleResource

    Returns LogSearchRuleResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LogSearchRuleResource, currentIndex: number, array: LogSearchRuleResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: LogSearchRuleResource
          • currentIndex: number
          • array: LogSearchRuleResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LogSearchRuleResource
  • reduceRight(callbackfn: function, initialValue: LogSearchRuleResource): LogSearchRuleResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LogSearchRuleResource, currentValue: LogSearchRuleResource, currentIndex: number, array: LogSearchRuleResource[]): LogSearchRuleResource
        • Parameters

          • previousValue: LogSearchRuleResource
          • currentValue: LogSearchRuleResource
          • currentIndex: number
          • array: LogSearchRuleResource[]

          Returns LogSearchRuleResource

    Returns LogSearchRuleResource

  • Parameters

    • callbackfn: function
        • (previousValue: LogSearchRuleResource, currentValue: LogSearchRuleResource, currentIndex: number, array: LogSearchRuleResource[]): LogSearchRuleResource
        • Parameters

          • previousValue: LogSearchRuleResource
          • currentValue: LogSearchRuleResource
          • currentIndex: number
          • array: LogSearchRuleResource[]

          Returns LogSearchRuleResource

    • initialValue: LogSearchRuleResource

    Returns LogSearchRuleResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LogSearchRuleResource, currentIndex: number, array: LogSearchRuleResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: LogSearchRuleResource
          • currentIndex: number
          • array: LogSearchRuleResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LogSearchRuleResource[]
  • Reverses the elements in an Array.

    Returns LogSearchRuleResource[]

shift

  • shift(): LogSearchRuleResource | undefined
  • Removes the first element from an array and returns it.

    Returns LogSearchRuleResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LogSearchRuleResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LogSearchRuleResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LogSearchRuleResource, index: number, array: LogSearchRuleResource[]): boolean
        • Parameters

          • value: LogSearchRuleResource
          • index: number
          • array: LogSearchRuleResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LogSearchRuleResource[]
  • splice(start: number, deleteCount: number, ...items: LogSearchRuleResource[]): LogSearchRuleResource[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LogSearchRuleResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LogSearchRuleResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns LogSearchRuleResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LogSearchRuleResource[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LogSearchRuleResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LogSearchRuleResource>
  • Returns an iterable of values in the array

    Returns IterableIterator<LogSearchRuleResource>

type

type: object

className

className: string = "LogSearchRuleResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LogSearchRuleResource"

name

name: "Composite" = "Composite"

Const LogSearchRuleResourcePatch

LogSearchRuleResourcePatch: object

The log search rule resource for patch operations.

Optional enabled

enabled: Enabled

The flag which indicates whether the Log Search rule is enabled. Value should be true or false. Possible values include: 'true', 'false'

serializedName

serializedName: string = "LogSearchRuleResourcePatch"

Optional tags

tags: undefined | object

Resource tags

type

type: object

className

className: string = "LogSearchRuleResourcePatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const LogSettings

LogSettings: object

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.

Optional category

category: undefined | string

Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.

enabled

enabled: boolean

a value indicating whether this log is enabled.

Optional retentionPolicy

retentionPolicy: RetentionPolicy

the retention policy for this log.

serializedName

serializedName: string = "LogSettings"

type

type: object

className

className: string = "LogSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

category

category: object

serializedName

serializedName: string = "category"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

Const LogToMetricAction

LogToMetricAction: object

Specify action need to be taken when rule type is converting log to metric

criteria

criteria: Criteria

Severity of the alert

odatatype

odatatype: "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"

Polymorphic Discriminator

serializedName

serializedName: string = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"

type

type: object

className

className: string = "LogToMetricAction"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Action.type.polymorphicDiscriminator

uberParent

uberParent: string = "Action"

modelProperties

modelProperties: object

criteria

criteria: object

required

required: true = true

serializedName

serializedName: string = "criteria"

type

type: object

className

className: string = "Criteria"

name

name: "Composite" = "Composite"

Const LogicAppReceiver

LogicAppReceiver: object

A logic app receiver.

callbackUrl

callbackUrl: string

The callback url where http request sent to.

name

name: string

The name of the logic app receiver. Names must be unique across all receivers within an action group.

resourceId

resourceId: string

The azure resource id of the logic app receiver.

serializedName

serializedName: string = "LogicAppReceiver"

useCommonAlertSchema

useCommonAlertSchema: boolean

Indicates whether to use common alert schema.

type

type: object

className

className: string = "LogicAppReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

callbackUrl

callbackUrl: object

required

required: true = true

serializedName

serializedName: string = "callbackUrl"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

required

required: true = true

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

useCommonAlertSchema

useCommonAlertSchema: object

required

required: true = true

serializedName

serializedName: string = "useCommonAlertSchema"

type

type: object

name

name: "Boolean" = "Boolean"

Const ManagementEventAggregationCondition

ManagementEventAggregationCondition: object

How the data that is collected should be combined over time.

Optional operator

the condition operator. Possible values include: 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'

serializedName

serializedName: string = "ManagementEventAggregationCondition"

Optional threshold

threshold: undefined | number

The threshold value that activates the alert.

Optional windowSize

windowSize: undefined | string

the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.

type

type: object

className

className: string = "ManagementEventAggregationCondition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operator

operator: object

serializedName

serializedName: string = "operator"

type

type: object

allowedValues

allowedValues: string[] = ["GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual"]

name

name: "Enum" = "Enum"

threshold

threshold: object

serializedName

serializedName: string = "threshold"

type

type: object

name

name: "Number" = "Number"

windowSize

windowSize: object

serializedName

serializedName: string = "windowSize"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const ManagementEventRuleCondition

ManagementEventRuleCondition: object

A management event rule condition.

Optional aggregation

How the data that is collected should be combined over time and when the alert is activated. Note that for management event alerts aggregation is optional – if it is not provided then any event will cause the alert to activate.

Optional dataSource

the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

odatatype

odatatype: "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"

Polymorphic Discriminator

serializedName

serializedName: string = "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"

type

type: object

className

className: string = "ManagementEventRuleCondition"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RuleCondition.type.polymorphicDiscriminator

uberParent

uberParent: string = "RuleCondition"

modelProperties

modelProperties: object

aggregation

aggregation: object

serializedName

serializedName: string = "aggregation"

type

type: object

className

className: string = "ManagementEventAggregationCondition"

name

name: "Composite" = "Composite"

Const MetadataValue

MetadataValue: object

Represents a metric metadata value.

Optional name

the name of the metadata.

serializedName

serializedName: string = "MetadataValue"

Optional value

value: undefined | string

the value of the metadata.

type

type: object

className

className: string = "MetadataValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const Metric

Metric: object

The result data of a query.

id

id: string

the metric Id.

name

name: LocalizableString

the name and the display name of the metric, i.e. it is localizable string.

serializedName

serializedName: string = "Metric"

timeseries

timeseries: TimeSeriesElement[]

the time series returned when a data query is performed.

unit

unit: Unit

the unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'CountPerSecond', 'BytesPerSecond', 'Percent', 'MilliSeconds', 'ByteSeconds', 'Unspecified'

type

type: object

the resource type of the metric resource.

className

className: string = "Metric"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

timeseries

timeseries: object

required

required: true = true

serializedName

serializedName: string = "timeseries"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TimeSeriesElement"

name

name: "Composite" = "Composite"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

unit

unit: object

required

required: true = true

serializedName

serializedName: string = "unit"

type

type: object

allowedValues

allowedValues: string[] = ["Count","Bytes","Seconds","CountPerSecond","BytesPerSecond","Percent","MilliSeconds","ByteSeconds","Unspecified"]

name

name: "Enum" = "Enum"

Const MetricAlertAction

MetricAlertAction: object

An alert action.

Optional actionGroupId

actionGroupId: undefined | string

the id of the action group to use.

serializedName

serializedName: string = "MetricAlertAction"

Optional webhookProperties

webhookProperties: undefined | object

The properties of a webhook object.

type

type: object

className

className: string = "MetricAlertAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionGroupId

actionGroupId: object

serializedName

serializedName: string = "actionGroupId"

type

type: object

name

name: "String" = "String"

webhookProperties

webhookProperties: object

serializedName

serializedName: string = "webhookProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const MetricAlertCriteria

MetricAlertCriteria: object

The rule criteria that defines the conditions of the alert rule.

odatatype

odatatype: "MetricAlertCriteria"

Polymorphic Discriminator

serializedName

serializedName: string = "MetricAlertCriteria"

type

type: object

className

className: string = "MetricAlertCriteria"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "MetricAlertCriteria"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "odata.type"

Const MetricAlertMultipleResourceMultipleMetricCriteria

MetricAlertMultipleResourceMultipleMetricCriteria: object

Specifies the metric alert criteria for multiple resource that has multiple metric criteria.

Optional allOf

the list of multiple metric criteria for this 'all of' operation.

odatatype

odatatype: "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"

Polymorphic Discriminator

serializedName

serializedName: string = "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"

type

type: object

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = MetricAlertCriteria.type.additionalProperties

className

className: string = "MetricAlertMultipleResourceMultipleMetricCriteria"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = MetricAlertCriteria.type.polymorphicDiscriminator

uberParent

uberParent: string = "MetricAlertCriteria"

modelProperties

modelProperties: object

allOf

allOf: object

serializedName

serializedName: string = "allOf"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MultiMetricCriteria"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const MetricAlertResource

MetricAlertResource: object

The metric alert resource.

Optional actions

actions: MetricAlertAction[]

the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

Optional autoMitigate

autoMitigate: undefined | false | true

the flag that indicates whether the alert should be auto resolved or not.

criteria

defines the specific alert criteria information.

description

description: string

the description of the metric alert that will be included in the alert email.

enabled

enabled: boolean

the flag that indicates whether the metric alert is enabled.

evaluationFrequency

evaluationFrequency: string

how often the metric alert is evaluated represented in ISO 8601 duration format.

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastUpdatedTime

lastUpdatedTime: Date

Last time the rule was updated in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

Optional scopes

scopes: string[]

the list of resource id's that this metric alert is scoped to.

serializedName

serializedName: string = "MetricAlertResource"

severity

severity: number

Alert severity {0, 1, 2, 3, 4}

Optional tags

tags: undefined | object

Resource tags

Optional targetResourceRegion

targetResourceRegion: undefined | string

the region of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria.

Optional targetResourceType

targetResourceType: undefined | string

the resource type of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria.

windowSize

windowSize: string

the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

type

type: object

className

className: string = "MetricAlertResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actions

actions: object

serializedName

serializedName: string = "properties.actions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricAlertAction"

name

name: "Composite" = "Composite"

autoMitigate

autoMitigate: object

serializedName

serializedName: string = "properties.autoMitigate"

type

type: object

name

name: "Boolean" = "Boolean"

criteria

criteria: object

required

required: true = true

serializedName

serializedName: string = "properties.criteria"

type

type: object

className

className: string = "MetricAlertCriteria"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

description

description: object

required

required: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

evaluationFrequency

evaluationFrequency: object

required

required: true = true

serializedName

serializedName: string = "properties.evaluationFrequency"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

lastUpdatedTime

lastUpdatedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastUpdatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

scopes

scopes: object

serializedName

serializedName: string = "properties.scopes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

severity

severity: object

required

required: true = true

serializedName

serializedName: string = "properties.severity"

type

type: object

name

name: "Number" = "Number"

targetResourceRegion

targetResourceRegion: object

serializedName

serializedName: string = "properties.targetResourceRegion"

type

type: object

name

name: "String" = "String"

targetResourceType

targetResourceType: object

serializedName

serializedName: string = "properties.targetResourceType"

type

type: object

name

name: "String" = "String"

windowSize

windowSize: object

required

required: true = true

serializedName

serializedName: string = "properties.windowSize"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const MetricAlertResourceCollection

MetricAlertResourceCollection: object
interface

Represents a collection of alert rule resources.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "MetricAlertResourceCollection"

__@iterator

  • __@iterator(): IterableIterator<MetricAlertResource>
  • Iterator

    Returns IterableIterator<MetricAlertResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<MetricAlertResource>[]): MetricAlertResource[]
  • concat(...items: (T | ConcatArray<T>)[]): MetricAlertResource[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<MetricAlertResource>[]

      Additional items to add to the end of array1.

    Returns MetricAlertResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns MetricAlertResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, MetricAlertResource]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, MetricAlertResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: MetricAlertResource, index: number, array: MetricAlertResource[]): boolean
        • Parameters

          • value: MetricAlertResource
          • index: number
          • array: MetricAlertResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: MetricAlertResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: MetricAlertResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): MetricAlertResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: MetricAlertResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricAlertResource, index: number, array: MetricAlertResource[]): boolean
        • Parameters

          • value: MetricAlertResource
          • index: number
          • array: MetricAlertResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricAlertResource, index: number, array: MetricAlertResource[]): any
        • Parameters

          • value: MetricAlertResource
          • index: number
          • array: MetricAlertResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns MetricAlertResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): MetricAlertResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: MetricAlertResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: MetricAlertResource, index: number, obj: MetricAlertResource[]): boolean
        • Parameters

          • this: void
          • value: MetricAlertResource
          • index: number
          • obj: MetricAlertResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: MetricAlertResource, index: number, obj: MetricAlertResource[]): boolean
        • Parameters

          • value: MetricAlertResource
          • index: number
          • obj: MetricAlertResource[]

          Returns boolean

    • Optional thisArg: any

    Returns MetricAlertResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: MetricAlertResource, index: number, obj: MetricAlertResource[]): boolean
        • Parameters

          • value: MetricAlertResource
          • index: number
          • obj: MetricAlertResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: MetricAlertResource, index: number, array: MetricAlertResource[]): void
        • Parameters

          • value: MetricAlertResource
          • index: number
          • array: MetricAlertResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: MetricAlertResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: MetricAlertResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: MetricAlertResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: MetricAlertResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: MetricAlertResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: MetricAlertResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: MetricAlertResource, index: number, array: MetricAlertResource[]): U
        • Parameters

          • value: MetricAlertResource
          • index: number
          • array: MetricAlertResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): MetricAlertResource | undefined
  • Removes the last element from an array and returns it.

    Returns MetricAlertResource | undefined

push

  • push(...items: MetricAlertResource[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: MetricAlertResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): MetricAlertResource
  • reduce(callbackfn: function, initialValue: MetricAlertResource): MetricAlertResource
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricAlertResource, currentValue: MetricAlertResource, currentIndex: number, array: MetricAlertResource[]): MetricAlertResource
        • Parameters

          • previousValue: MetricAlertResource
          • currentValue: MetricAlertResource
          • currentIndex: number
          • array: MetricAlertResource[]

          Returns MetricAlertResource

    Returns MetricAlertResource

  • Parameters

    • callbackfn: function
        • (previousValue: MetricAlertResource, currentValue: MetricAlertResource, currentIndex: number, array: MetricAlertResource[]): MetricAlertResource
        • Parameters

          • previousValue: MetricAlertResource
          • currentValue: MetricAlertResource
          • currentIndex: number
          • array: MetricAlertResource[]

          Returns MetricAlertResource

    • initialValue: MetricAlertResource

    Returns MetricAlertResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricAlertResource, currentIndex: number, array: MetricAlertResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricAlertResource
          • currentIndex: number
          • array: MetricAlertResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): MetricAlertResource
  • reduceRight(callbackfn: function, initialValue: MetricAlertResource): MetricAlertResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricAlertResource, currentValue: MetricAlertResource, currentIndex: number, array: MetricAlertResource[]): MetricAlertResource
        • Parameters

          • previousValue: MetricAlertResource
          • currentValue: MetricAlertResource
          • currentIndex: number
          • array: MetricAlertResource[]

          Returns MetricAlertResource

    Returns MetricAlertResource

  • Parameters

    • callbackfn: function
        • (previousValue: MetricAlertResource, currentValue: MetricAlertResource, currentIndex: number, array: MetricAlertResource[]): MetricAlertResource
        • Parameters

          • previousValue: MetricAlertResource
          • currentValue: MetricAlertResource
          • currentIndex: number
          • array: MetricAlertResource[]

          Returns MetricAlertResource

    • initialValue: MetricAlertResource

    Returns MetricAlertResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricAlertResource, currentIndex: number, array: MetricAlertResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricAlertResource
          • currentIndex: number
          • array: MetricAlertResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): MetricAlertResource[]
  • Reverses the elements in an Array.

    Returns MetricAlertResource[]

shift

  • shift(): MetricAlertResource | undefined
  • Removes the first element from an array and returns it.

    Returns MetricAlertResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): MetricAlertResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns MetricAlertResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: MetricAlertResource, index: number, array: MetricAlertResource[]): boolean
        • Parameters

          • value: MetricAlertResource
          • index: number
          • array: MetricAlertResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): MetricAlertResource[]
  • splice(start: number, deleteCount: number, ...items: MetricAlertResource[]): MetricAlertResource[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns MetricAlertResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: MetricAlertResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns MetricAlertResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: MetricAlertResource[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: MetricAlertResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<MetricAlertResource>
  • Returns an iterable of values in the array

    Returns IterableIterator<MetricAlertResource>

type

type: object

className

className: string = "MetricAlertResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricAlertResource"

name

name: "Composite" = "Composite"

Const MetricAlertResourcePatch

MetricAlertResourcePatch: object

The metric alert resource for patch operations.

Optional actions

actions: MetricAlertAction[]

the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

Optional autoMitigate

autoMitigate: undefined | false | true

the flag that indicates whether the alert should be auto resolved or not.

criteria

defines the specific alert criteria information.

description

description: string

the description of the metric alert that will be included in the alert email.

enabled

enabled: boolean

the flag that indicates whether the metric alert is enabled.

evaluationFrequency

evaluationFrequency: string

how often the metric alert is evaluated represented in ISO 8601 duration format.

Optional lastUpdatedTime

lastUpdatedTime: Date

Last time the rule was updated in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scopes

scopes: string[]

the list of resource id's that this metric alert is scoped to.

serializedName

serializedName: string = "MetricAlertResourcePatch"

severity

severity: number

Alert severity {0, 1, 2, 3, 4}

Optional tags

tags: undefined | object

Resource tags

Optional targetResourceRegion

targetResourceRegion: undefined | string

the region of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria.

Optional targetResourceType

targetResourceType: undefined | string

the resource type of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria.

windowSize

windowSize: string

the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

type

type: object

className

className: string = "MetricAlertResourcePatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actions

actions: object

serializedName

serializedName: string = "properties.actions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricAlertAction"

name

name: "Composite" = "Composite"

autoMitigate

autoMitigate: object

serializedName

serializedName: string = "properties.autoMitigate"

type

type: object

name

name: "Boolean" = "Boolean"

criteria

criteria: object

required

required: true = true

serializedName

serializedName: string = "properties.criteria"

type

type: object

className

className: string = "MetricAlertCriteria"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

description

description: object

required

required: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

evaluationFrequency

evaluationFrequency: object

required

required: true = true

serializedName

serializedName: string = "properties.evaluationFrequency"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

lastUpdatedTime

lastUpdatedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastUpdatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

scopes

scopes: object

serializedName

serializedName: string = "properties.scopes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

severity

severity: object

required

required: true = true

serializedName

serializedName: string = "properties.severity"

type

type: object

name

name: "Number" = "Number"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

targetResourceRegion

targetResourceRegion: object

serializedName

serializedName: string = "properties.targetResourceRegion"

type

type: object

name

name: "String" = "String"

targetResourceType

targetResourceType: object

serializedName

serializedName: string = "properties.targetResourceType"

type

type: object

name

name: "String" = "String"

windowSize

windowSize: object

required

required: true = true

serializedName

serializedName: string = "properties.windowSize"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const MetricAlertSingleResourceMultipleMetricCriteria

MetricAlertSingleResourceMultipleMetricCriteria: object

Specifies the metric alert criteria for a single resource that has multiple metric criteria.

Optional allOf

allOf: MetricCriteria[]

The list of metric criteria for this 'all of' operation.

odatatype

odatatype: "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"

Polymorphic Discriminator

serializedName

serializedName: string = "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"

type

type: object

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = MetricAlertCriteria.type.additionalProperties

className

className: string = "MetricAlertSingleResourceMultipleMetricCriteria"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = MetricAlertCriteria.type.polymorphicDiscriminator

uberParent

uberParent: string = "MetricAlertCriteria"

modelProperties

modelProperties: object

allOf

allOf: object

serializedName

serializedName: string = "allOf"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = MultiMetricCriteria.type.additionalProperties

className

className: string = "MetricCriteria"

name

name: "Composite" = "Composite"

Const MetricAlertStatus

MetricAlertStatus: object

An alert status.

Optional id

id: undefined | string

The alert rule arm id.

Optional name

name: undefined | string

The status name.

Optional properties

The alert status properties of the metric alert status.

serializedName

serializedName: string = "MetricAlertStatus"

type

type: object

The extended resource type name.

className

className: string = "MetricAlertStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "MetricAlertStatusProperties"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const MetricAlertStatusCollection

MetricAlertStatusCollection: object

Represents a collection of alert rule resources.

serializedName

serializedName: string = "MetricAlertStatusCollection"

Optional value

value: MetricAlertStatus[]

the values for the alert rule resources.

type

type: object

className

className: string = "MetricAlertStatusCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricAlertStatus"

name

name: "Composite" = "Composite"

Const MetricAlertStatusProperties

MetricAlertStatusProperties: object

An alert status properties.

Optional dimensions

dimensions: undefined | object

An object describing the type of the dimensions.

serializedName

serializedName: string = "MetricAlertStatusProperties"

Optional status

status: undefined | string

status value

Optional timestamp

timestamp: Date

UTC time when the status was checked.

type

type: object

className

className: string = "MetricAlertStatusProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

timestamp

timestamp: object

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: "DateTime" = "DateTime"

Const MetricAvailability

MetricAvailability: object

Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.

Optional retention

retention: undefined | string

the retention period for the metric at the specified timegrain. Expressed as a duration 'PT1M', 'P1D', etc.

serializedName

serializedName: string = "MetricAvailability"

Optional timeGrain

timeGrain: undefined | string

the time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'P1D', etc.

type

type: object

className

className: string = "MetricAvailability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

retention

retention: object

serializedName

serializedName: string = "retention"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const MetricCriteria

MetricCriteria: object

Criterion to filter metrics.

criterionType

criterionType: "StaticThresholdCriterion"

Polymorphic Discriminator

Optional dimensions

dimensions: MetricDimension[]

List of dimension conditions.

metricName

metricName: string

Name of the metric.

Optional metricNamespace

metricNamespace: undefined | string

Namespace of the metric.

name

name: string

Name of the criteria.

operator

operator: any

the criteria operator.

serializedName

serializedName: string = "StaticThresholdCriterion"

threshold

threshold: number

the criteria threshold value that activates the alert.

timeAggregation

timeAggregation: any

the criteria time aggregation types.

type

type: object

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = MultiMetricCriteria.type.additionalProperties

className

className: string = "MetricCriteria"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = MultiMetricCriteria.type.polymorphicDiscriminator

uberParent

uberParent: string = "MultiMetricCriteria"

modelProperties

modelProperties: object

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricDimension"

name

name: "Composite" = "Composite"

metricName

metricName: object

required

required: true = true

serializedName

serializedName: string = "metricName"

type

type: object

name

name: "String" = "String"

metricNamespace

metricNamespace: object

serializedName

serializedName: string = "metricNamespace"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

operator

operator: object

required

required: true = true

serializedName

serializedName: string = "operator"

type

type: object

name

name: "Object" = "Object"

threshold

threshold: object

required

required: true = true

serializedName

serializedName: string = "threshold"

type

type: object

name

name: "Number" = "Number"

timeAggregation

timeAggregation: object

required

required: true = true

serializedName

serializedName: string = "timeAggregation"

type

type: object

name

name: "Object" = "Object"

Const MetricDefinition

MetricDefinition: object

Metric definition class specifies the metadata for a metric.

Optional dimensions

dimensions: LocalizableString[]

the name and the display name of the dimension, i.e. it is a localizable string.

Optional id

id: undefined | string

the resource identifier of the metric definition.

Optional isDimensionRequired

isDimensionRequired: undefined | false | true

Flag to indicate whether the dimension is required.

Optional metricAvailabilities

metricAvailabilities: MetricAvailability[]

the collection of what aggregation intervals are available to be queried.

Optional name

the name and the display name of the metric, i.e. it is a localizable string.

Optional namespace

namespace: undefined | string

the namespace the metric belongs to.

Optional primaryAggregationType

primaryAggregationType: AggregationType

the primary aggregation type value defining how to use the values for display. Possible values include: 'None', 'Average', 'Count', 'Minimum', 'Maximum', 'Total'

Optional resourceId

resourceId: undefined | string

the resource identifier of the resource that emitted the metric.

serializedName

serializedName: string = "MetricDefinition"

Optional supportedAggregationTypes

supportedAggregationTypes: AggregationType[]

the collection of what aggregation types are supported.

Optional unit

unit: Unit

the unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'CountPerSecond', 'BytesPerSecond', 'Percent', 'MilliSeconds', 'ByteSeconds', 'Unspecified'

type

type: object

className

className: string = "MetricDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

isDimensionRequired

isDimensionRequired: object

serializedName

serializedName: string = "isDimensionRequired"

type

type: object

name

name: "Boolean" = "Boolean"

metricAvailabilities

metricAvailabilities: object

serializedName

serializedName: string = "metricAvailabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricAvailability"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

namespace

namespace: object

serializedName

serializedName: string = "namespace"

type

type: object

name

name: "String" = "String"

primaryAggregationType

primaryAggregationType: object

serializedName

serializedName: string = "primaryAggregationType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Average","Count","Minimum","Maximum","Total"]

name

name: "Enum" = "Enum"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

supportedAggregationTypes

supportedAggregationTypes: object

serializedName

serializedName: string = "supportedAggregationTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["None","Average","Count","Minimum","Maximum","Total"]

name

name: "Enum" = "Enum"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

allowedValues

allowedValues: string[] = ["Count","Bytes","Seconds","CountPerSecond","BytesPerSecond","Percent","MilliSeconds","ByteSeconds","Unspecified"]

name

name: "Enum" = "Enum"

Const MetricDefinitionCollection

MetricDefinitionCollection: object
interface

Represents collection of metric definitions.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "MetricDefinitionCollection"

__@iterator

  • __@iterator(): IterableIterator<MetricDefinition>
  • Iterator

    Returns IterableIterator<MetricDefinition>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<MetricDefinition>[]): MetricDefinition[]
  • concat(...items: (T | ConcatArray<T>)[]): MetricDefinition[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<MetricDefinition>[]

      Additional items to add to the end of array1.

    Returns MetricDefinition[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns MetricDefinition[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, MetricDefinition]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, MetricDefinition]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: MetricDefinition, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: MetricDefinition

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): MetricDefinition[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: MetricDefinition

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): any
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns MetricDefinition[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): MetricDefinition | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: MetricDefinition

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • this: void
          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

    Returns MetricDefinition | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): void
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: MetricDefinition, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: MetricDefinition

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: MetricDefinition, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: MetricDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: MetricDefinition, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: MetricDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): U
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): MetricDefinition | undefined
  • Removes the last element from an array and returns it.

    Returns MetricDefinition | undefined

push

  • push(...items: MetricDefinition[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: MetricDefinition[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): MetricDefinition
  • reduce(callbackfn: function, initialValue: MetricDefinition): MetricDefinition
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    Returns MetricDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    • initialValue: MetricDefinition

    Returns MetricDefinition

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): MetricDefinition
  • reduceRight(callbackfn: function, initialValue: MetricDefinition): MetricDefinition
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    Returns MetricDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    • initialValue: MetricDefinition

    Returns MetricDefinition

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): MetricDefinition[]
  • Reverses the elements in an Array.

    Returns MetricDefinition[]

shift

  • shift(): MetricDefinition | undefined
  • Removes the first element from an array and returns it.

    Returns MetricDefinition | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): MetricDefinition[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns MetricDefinition[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): MetricDefinition[]
  • splice(start: number, deleteCount: number, ...items: MetricDefinition[]): MetricDefinition[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns MetricDefinition[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: MetricDefinition[]

      Elements to insert into the array in place of the deleted elements.

    Returns MetricDefinition[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: MetricDefinition[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: MetricDefinition[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<MetricDefinition>
  • Returns an iterable of values in the array

    Returns IterableIterator<MetricDefinition>

type

type: object

className

className: string = "MetricDefinitionCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricDefinition"

name

name: "Composite" = "Composite"

Const MetricDimension

MetricDimension: object

Specifies a metric dimension.

name

name: string

Name of the dimension.

operator

operator: string

the dimension operator. Only 'Include' and 'Exclude' are supported

serializedName

serializedName: string = "MetricDimension"

values

values: string[]

list of dimension values.

type

type: object

className

className: string = "MetricDimension"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

operator

operator: object

required

required: true = true

serializedName

serializedName: string = "operator"

type

type: object

name

name: "String" = "String"

values

values: object

required

required: true = true

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const MetricNamespace

MetricNamespace: object

Metric namespace class specifies the metadata for a metric namespace.

Optional id

id: undefined | string

The ID of the metricNamespace.

Optional name

name: undefined | string

The name of the namespace.

Optional properties

Properties which include the fully qualified namespace name.

serializedName

serializedName: string = "MetricNamespace"

type

type: object

The type of the namespace.

className

className: string = "MetricNamespace"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "MetricNamespaceName"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const MetricNamespaceCollection

MetricNamespaceCollection: object
interface

Represents collection of metric namespaces.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "MetricNamespaceCollection"

__@iterator

  • __@iterator(): IterableIterator<MetricNamespace>
  • Iterator

    Returns IterableIterator<MetricNamespace>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<MetricNamespace>[]): MetricNamespace[]
  • concat(...items: (T | ConcatArray<T>)[]): MetricNamespace[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<MetricNamespace>[]

      Additional items to add to the end of array1.

    Returns MetricNamespace[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns MetricNamespace[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, MetricNamespace]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, MetricNamespace]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: MetricNamespace, index: number, array: MetricNamespace[]): boolean
        • Parameters

          • value: MetricNamespace
          • index: number
          • array: MetricNamespace[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: MetricNamespace, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: MetricNamespace

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): MetricNamespace[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: MetricNamespace

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricNamespace, index: number, array: MetricNamespace[]): boolean
        • Parameters

          • value: MetricNamespace
          • index: number
          • array: MetricNamespace[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricNamespace, index: number, array: MetricNamespace[]): any
        • Parameters

          • value: MetricNamespace
          • index: number
          • array: MetricNamespace[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns MetricNamespace[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): MetricNamespace | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: MetricNamespace

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: MetricNamespace, index: number, obj: MetricNamespace[]): boolean
        • Parameters

          • this: void
          • value: MetricNamespace
          • index: number
          • obj: MetricNamespace[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: MetricNamespace, index: number, obj: MetricNamespace[]): boolean
        • Parameters

          • value: MetricNamespace
          • index: number
          • obj: MetricNamespace[]

          Returns boolean

    • Optional thisArg: any

    Returns MetricNamespace | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: MetricNamespace, index: number, obj: MetricNamespace[]): boolean
        • Parameters

          • value: MetricNamespace
          • index: number
          • obj: MetricNamespace[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: MetricNamespace, index: number, array: MetricNamespace[]): void
        • Parameters

          • value: MetricNamespace
          • index: number
          • array: MetricNamespace[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: MetricNamespace, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: MetricNamespace

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: MetricNamespace, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: MetricNamespace

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: MetricNamespace, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: MetricNamespace

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: MetricNamespace, index: number, array: MetricNamespace[]): U
        • Parameters

          • value: MetricNamespace
          • index: number
          • array: MetricNamespace[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): MetricNamespace | undefined
  • Removes the last element from an array and returns it.

    Returns MetricNamespace | undefined

push

  • push(...items: MetricNamespace[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: MetricNamespace[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): MetricNamespace
  • reduce(callbackfn: function, initialValue: MetricNamespace): MetricNamespace
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricNamespace, currentValue: MetricNamespace, currentIndex: number, array: MetricNamespace[]): MetricNamespace
        • Parameters

          • previousValue: MetricNamespace
          • currentValue: MetricNamespace
          • currentIndex: number
          • array: MetricNamespace[]

          Returns MetricNamespace

    Returns MetricNamespace

  • Parameters

    • callbackfn: function
        • (previousValue: MetricNamespace, currentValue: MetricNamespace, currentIndex: number, array: MetricNamespace[]): MetricNamespace
        • Parameters

          • previousValue: MetricNamespace
          • currentValue: MetricNamespace
          • currentIndex: number
          • array: MetricNamespace[]

          Returns MetricNamespace

    • initialValue: MetricNamespace

    Returns MetricNamespace

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricNamespace, currentIndex: number, array: MetricNamespace[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricNamespace
          • currentIndex: number
          • array: MetricNamespace[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): MetricNamespace
  • reduceRight(callbackfn: function, initialValue: MetricNamespace): MetricNamespace
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricNamespace, currentValue: MetricNamespace, currentIndex: number, array: MetricNamespace[]): MetricNamespace
        • Parameters

          • previousValue: MetricNamespace
          • currentValue: MetricNamespace
          • currentIndex: number
          • array: MetricNamespace[]

          Returns MetricNamespace

    Returns MetricNamespace

  • Parameters

    • callbackfn: function
        • (previousValue: MetricNamespace, currentValue: MetricNamespace, currentIndex: number, array: MetricNamespace[]): MetricNamespace
        • Parameters

          • previousValue: MetricNamespace
          • currentValue: MetricNamespace
          • currentIndex: number
          • array: MetricNamespace[]

          Returns MetricNamespace

    • initialValue: MetricNamespace

    Returns MetricNamespace

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricNamespace, currentIndex: number, array: MetricNamespace[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricNamespace
          • currentIndex: number
          • array: MetricNamespace[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): MetricNamespace[]
  • Reverses the elements in an Array.

    Returns MetricNamespace[]

shift

  • shift(): MetricNamespace | undefined
  • Removes the first element from an array and returns it.

    Returns MetricNamespace | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): MetricNamespace[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns MetricNamespace[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: MetricNamespace, index: number, array: MetricNamespace[]): boolean
        • Parameters

          • value: MetricNamespace
          • index: number
          • array: MetricNamespace[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): MetricNamespace[]
  • splice(start: number, deleteCount: number, ...items: MetricNamespace[]): MetricNamespace[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns MetricNamespace[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: MetricNamespace[]

      Elements to insert into the array in place of the deleted elements.

    Returns MetricNamespace[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: MetricNamespace[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: MetricNamespace[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<MetricNamespace>
  • Returns an iterable of values in the array

    Returns IterableIterator<MetricNamespace>

type

type: object

className

className: string = "MetricNamespaceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricNamespace"

name

name: "Composite" = "Composite"

Const MetricNamespaceName

MetricNamespaceName: object

The fully qualified metric namespace name.

Optional metricNamespaceName

metricNamespaceName: undefined | string

The metric namespace name.

serializedName

serializedName: string = "MetricNamespaceName"

type

type: object

className

className: string = "MetricNamespaceName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metricNamespaceName

metricNamespaceName: object

serializedName

serializedName: string = "metricNamespaceName"

type

type: object

name

name: "String" = "String"

Const MetricSettings

MetricSettings: object

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric.

Optional category

category: undefined | string

Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.

enabled

enabled: boolean

a value indicating whether this category is enabled.

Optional retentionPolicy

retentionPolicy: RetentionPolicy

the retention policy for this category.

serializedName

serializedName: string = "MetricSettings"

Optional timeGrain

timeGrain: undefined | string

the timegrain of the metric in ISO8601 format.

type

type: object

className

className: string = "MetricSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

category

category: object

serializedName

serializedName: string = "category"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const MetricTrigger

MetricTrigger: object

The trigger that results in a scaling action.

metricName

metricName: string

the name of the metric that defines what the rule monitors.

metricResourceUri

metricResourceUri: string

the resource identifier of the resource the rule monitors.

operator

the operator that is used to compare the metric data and the threshold. Possible values include: 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'

serializedName

serializedName: string = "MetricTrigger"

statistic

the metric statistic type. How the metrics from multiple instances are combined. Possible values include: 'Average', 'Min', 'Max', 'Sum'

threshold

threshold: number

the threshold of the metric that triggers the scale action.

timeAggregation

timeAggregation: TimeAggregationType

time aggregation type. How the data that is collected should be combined over time. The default value is Average. Possible values include: 'Average', 'Minimum', 'Maximum', 'Total', 'Count', 'Last'

timeGrain

timeGrain: string

the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute.

timeWindow

timeWindow: string

the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes.

type

type: object

className

className: string = "MetricTrigger"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metricName

metricName: object

required

required: true = true

serializedName

serializedName: string = "metricName"

type

type: object

name

name: "String" = "String"

metricResourceUri

metricResourceUri: object

required

required: true = true

serializedName

serializedName: string = "metricResourceUri"

type

type: object

name

name: "String" = "String"

operator

operator: object

required

required: true = true

serializedName

serializedName: string = "operator"

type

type: object

allowedValues

allowedValues: string[] = ["Equals","NotEquals","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual"]

name

name: "Enum" = "Enum"

statistic

statistic: object

required

required: true = true

serializedName

serializedName: string = "statistic"

type

type: object

allowedValues

allowedValues: string[] = ["Average","Min","Max","Sum"]

name

name: "Enum" = "Enum"

threshold

threshold: object

required

required: true = true

serializedName

serializedName: string = "threshold"

type

type: object

name

name: "Number" = "Number"

timeAggregation

timeAggregation: object

required

required: true = true

serializedName

serializedName: string = "timeAggregation"

type

type: object

allowedValues

allowedValues: string[] = ["Average","Minimum","Maximum","Total","Count","Last"]

name

name: "Enum" = "Enum"

timeGrain

timeGrain: object

required

required: true = true

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

timeWindow

timeWindow: object

required

required: true = true

serializedName

serializedName: string = "timeWindow"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const MetricValue

MetricValue: object

Represents a metric value.

Optional average

average: undefined | number

the average value in the time range.

Optional count

count: undefined | number

the number of samples in the time range. Can be used to determine the number of values that contributed to the average value.

Optional maximum

maximum: undefined | number

the greatest value in the time range.

Optional minimum

minimum: undefined | number

the least value in the time range.

serializedName

serializedName: string = "MetricValue"

timeStamp

timeStamp: Date

the timestamp for the metric value in ISO 8601 format.

Optional total

total: undefined | number

the sum of all of the values in the time range.

type

type: object

className

className: string = "MetricValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

average

average: object

serializedName

serializedName: string = "average"

type

type: object

name

name: "Number" = "Number"

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

maximum

maximum: object

serializedName

serializedName: string = "maximum"

type

type: object

name

name: "Number" = "Number"

minimum

minimum: object

serializedName

serializedName: string = "minimum"

type

type: object

name

name: "Number" = "Number"

timeStamp

timeStamp: object

required

required: true = true

serializedName

serializedName: string = "timeStamp"

type

type: object

name

name: "DateTime" = "DateTime"

total

total: object

serializedName

serializedName: string = "total"

type

type: object

name

name: "Number" = "Number"

Const MultiMetricCriteria

MultiMetricCriteria: object

The types of conditions for a multi resource alert

criterionType

criterionType: "MultiMetricCriteria"

Polymorphic Discriminator

serializedName

serializedName: string = "MultiMetricCriteria"

type

type: object

className

className: string = "MultiMetricCriteria"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "MultiMetricCriteria"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

criterionType

criterionType: object

required

required: true = true

serializedName

serializedName: string = "criterionType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "criterionType"

serializedName

serializedName: string = "criterionType"

Const Operation

Operation: object

Microsoft Insights API operation definition.

Optional display

Display metadata associated with the operation.

Optional name

name: undefined | string

Operation name: {provider}/{resource}/{operation}

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const OperationDisplay

OperationDisplay: object

Display metadata associated with the operation.

Optional operation

operation: undefined | string

Operation type: Read, write, delete, etc.

Optional provider

provider: undefined | string

Service provider: Microsoft.Insights

Optional resource

resource: undefined | string

Resource on which the operation is performed: AlertRules, Autoscale, etc.

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationListResult

OperationListResult: object

Result of the request to list Microsoft.Insights operations. It contains a list of operations and a URL link to get the next set of results.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "OperationListResult"

Optional value

value: Operation[]

List of operations supported by the Microsoft.Insights provider.

type

type: object

className

className: string = "OperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const ProxyOnlyResource

ProxyOnlyResource: object

A proxy only azure resource object

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProxyOnlyResource"

type

type: object

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProxyOnlyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ProxyResource

ProxyResource: object

An azure resource object

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProxyResource"

type

type: object

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProxyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const Recurrence

Recurrence: object

The repeating times at which this profile begins. This element is not used if the FixedDate element is used.

frequency

the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set schedule to every day of the week. The frequency property specifies that the schedule is repeated weekly. Possible values include: 'None', 'Second', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year'

schedule

schedule: RecurrentSchedule

the scheduling constraints for when the profile begins.

serializedName

serializedName: string = "Recurrence"

type

type: object

className

className: string = "Recurrence"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

frequency

frequency: object

required

required: true = true

serializedName

serializedName: string = "frequency"

type

type: object

allowedValues

allowedValues: string[] = ["None","Second","Minute","Hour","Day","Week","Month","Year"]

name

name: "Enum" = "Enum"

schedule

schedule: object

required

required: true = true

serializedName

serializedName: string = "schedule"

type

type: object

className

className: string = "RecurrentSchedule"

name

name: "Composite" = "Composite"

Const RecurrentSchedule

RecurrentSchedule: object

The scheduling constraints for when the profile begins.

days

days: string[]

the collection of days that the profile takes effect on. Possible values are Sunday through Saturday.

hours

hours: number[]

A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported).

minutes

minutes: number[]

A collection of minutes at which the profile takes effect at.

serializedName

serializedName: string = "RecurrentSchedule"

timeZone

timeZone: string

the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time

type

type: object

className

className: string = "RecurrentSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

days

days: object

required

required: true = true

serializedName

serializedName: string = "days"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

hours

hours: object

required

required: true = true

serializedName

serializedName: string = "hours"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

minutes

minutes: object

required

required: true = true

serializedName

serializedName: string = "minutes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

timeZone

timeZone: object

required

required: true = true

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const Resource

Resource: object

An azure resource object

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional tags

tags: undefined | object

Resource tags

type

type: object

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const Response

Response: object

The response to a metrics query.

Optional cost

cost: undefined | number

The integer value representing the cost of the query, for data case.

Optional interval

interval: undefined | string

The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made.

Optional namespace

namespace: undefined | string

The namespace of the metrics been queried

Optional resourceregion

resourceregion: undefined | string

The region of the resource been queried for metrics.

serializedName

serializedName: string = "Response"

timespan

timespan: string

The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested.

value

value: Metric[]

the value of the collection.

type

type: object

className

className: string = "Response"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cost

cost: object

serializedName

serializedName: string = "cost"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

interval

interval: object

serializedName

serializedName: string = "interval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

namespace

namespace: object

serializedName

serializedName: string = "namespace"

type

type: object

name

name: "String" = "String"

resourceregion

resourceregion: object

serializedName

serializedName: string = "resourceregion"

type

type: object

name

name: "String" = "String"

timespan

timespan: object

required

required: true = true

serializedName

serializedName: string = "timespan"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Metric"

name

name: "Composite" = "Composite"

Const ResponseWithError

ResponseWithError: object

An error response from the API.

error

error: ErrorModel

Error information.

serializedName

serializedName: string = "ResponseWithError"

type

type: object

className

className: string = "ResponseWithError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

required

required: true = true

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: "Composite" = "Composite"

Const RetentionPolicy

RetentionPolicy: object

Specifies the retention policy for the log.

days

days: number

the number of days for the retention in days. A value of 0 will retain the events indefinitely.

enabled

enabled: boolean

a value indicating whether the retention policy is enabled.

serializedName

serializedName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

days

days: object

required

required: true = true

serializedName

serializedName: string = "days"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const RuleAction

RuleAction: object

The action that is performed when the alert rule becomes active, and when an alert condition is resolved.

odatatype

odatatype: "RuleAction"

Polymorphic Discriminator

serializedName

serializedName: string = "RuleAction"

type

type: object

className

className: string = "RuleAction"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RuleAction"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "odata.type"

Const RuleCondition

RuleCondition: object

The condition that results in the alert rule being activated.

Optional dataSource

the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

odatatype

odatatype: "RuleCondition"

Polymorphic Discriminator

serializedName

serializedName: string = "RuleCondition"

type

type: object

className

className: string = "RuleCondition"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RuleCondition"

modelProperties

modelProperties: object

dataSource

dataSource: object

serializedName

serializedName: string = "dataSource"

type

type: object

className

className: string = "RuleDataSource"

name

name: "Composite" = "Composite"

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "odata.type"

Const RuleDataSource

RuleDataSource: object

The resource from which the rule collects its data.

odatatype

odatatype: "RuleDataSource"

Polymorphic Discriminator

Optional resourceUri

resourceUri: undefined | string

the resource identifier of the resource the rule monitors. NOTE: this property cannot be updated for an existing rule.

serializedName

serializedName: string = "RuleDataSource"

type

type: object

className

className: string = "RuleDataSource"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RuleDataSource"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "odata\.type"

type

type: object

name

name: "String" = "String"

resourceUri

resourceUri: object

serializedName

serializedName: string = "resourceUri"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "odata.type"

Const RuleEmailAction

RuleEmailAction: object

Specifies the action to send email when the rule condition is evaluated. The discriminator is always RuleEmailAction in this case.

Optional customEmails

customEmails: string[]

the list of administrator's custom email addresses to notify of the activation of the alert.

odatatype

odatatype: "Microsoft.Azure.Management.Insights.Models.RuleEmailAction"

Polymorphic Discriminator

Optional sendToServiceOwners

sendToServiceOwners: undefined | false | true

Whether the administrators (service and co-administrators) of the service should be notified when the alert is activated.

serializedName

serializedName: string = "Microsoft.Azure.Management.Insights.Models.RuleEmailAction"

type

type: object

className

className: string = "RuleEmailAction"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RuleAction.type.polymorphicDiscriminator

uberParent

uberParent: string = "RuleAction"

modelProperties

modelProperties: object

customEmails

customEmails: object

serializedName

serializedName: string = "customEmails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sendToServiceOwners

sendToServiceOwners: object

serializedName

serializedName: string = "sendToServiceOwners"

type

type: object

name

name: "Boolean" = "Boolean"

Const RuleManagementEventClaimsDataSource

RuleManagementEventClaimsDataSource: object

The claims for a rule management event data source.

Optional emailAddress

emailAddress: undefined | string

the email address.

serializedName

serializedName: string = "RuleManagementEventClaimsDataSource"

type

type: object

className

className: string = "RuleManagementEventClaimsDataSource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

emailAddress

emailAddress: object

serializedName

serializedName: string = "emailAddress"

type

type: object

name

name: "String" = "String"

Const RuleManagementEventDataSource

RuleManagementEventDataSource: object

A rule management event data source. The discriminator fields is always RuleManagementEventDataSource in this case.

Optional claims

the claims.

Optional eventName

eventName: undefined | string

the event name.

Optional eventSource

eventSource: undefined | string

the event source.

Optional level

level: undefined | string

the level.

odatatype

odatatype: "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource"

Polymorphic Discriminator

Optional operationName

operationName: undefined | string

The name of the operation that should be checked for. If no name is provided, any operation will match.

Optional resourceGroupName

resourceGroupName: undefined | string

the resource group name.

Optional resourceProviderName

resourceProviderName: undefined | string

the resource provider name.

Optional resourceUri

resourceUri: undefined | string

the resource identifier of the resource the rule monitors. NOTE: this property cannot be updated for an existing rule.

serializedName

serializedName: string = "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource"

Optional status

status: undefined | string

The status of the operation that should be checked for. If no status is provided, any status will match.

Optional subStatus

subStatus: undefined | string

the substatus.

type

type: object

className

className: string = "RuleManagementEventDataSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RuleDataSource.type.polymorphicDiscriminator

uberParent

uberParent: string = "RuleDataSource"

modelProperties

modelProperties: object

claims

claims: object

serializedName

serializedName: string = "claims"

type

type: object

className

className: string = "RuleManagementEventClaimsDataSource"

name

name: "Composite" = "Composite"

eventName

eventName: object

serializedName

serializedName: string = "eventName"

type

type: object

name

name: "String" = "String"

eventSource

eventSource: object

serializedName

serializedName: string = "eventSource"

type

type: object

name

name: "String" = "String"

level

level: object

serializedName

serializedName: string = "level"

type

type: object

name

name: "String" = "String"

operationName

operationName: object

serializedName

serializedName: string = "operationName"

type

type: object

name

name: "String" = "String"

resourceGroupName

resourceGroupName: object

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

resourceProviderName

resourceProviderName: object

serializedName

serializedName: string = "resourceProviderName"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

subStatus

subStatus: object

serializedName

serializedName: string = "subStatus"

type

type: object

name

name: "String" = "String"

Const RuleMetricDataSource

RuleMetricDataSource: object

A rule metric data source. The discriminator value is always RuleMetricDataSource in this case.

Optional metricName

metricName: undefined | string

the name of the metric that defines what the rule monitors.

odatatype

odatatype: "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"

Polymorphic Discriminator

Optional resourceUri

resourceUri: undefined | string

the resource identifier of the resource the rule monitors. NOTE: this property cannot be updated for an existing rule.

serializedName

serializedName: string = "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"

type

type: object

className

className: string = "RuleMetricDataSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RuleDataSource.type.polymorphicDiscriminator

uberParent

uberParent: string = "RuleDataSource"

modelProperties

modelProperties: object

metricName

metricName: object

serializedName

serializedName: string = "metricName"

type

type: object

name

name: "String" = "String"

Const RuleWebhookAction

RuleWebhookAction: object

Specifies the action to post to service when the rule condition is evaluated. The discriminator is always RuleWebhookAction in this case.

odatatype

odatatype: "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction"

Polymorphic Discriminator

Optional properties

properties: undefined | object

the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.

serializedName

serializedName: string = "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction"

Optional serviceUri

serviceUri: undefined | string

the service uri to Post the notification when the alert activates or resolves.

type

type: object

className

className: string = "RuleWebhookAction"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RuleAction.type.polymorphicDiscriminator

uberParent

uberParent: string = "RuleAction"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

serviceUri

serviceUri: object

serializedName

serializedName: string = "serviceUri"

type

type: object

name

name: "String" = "String"

Const ScaleAction

ScaleAction: object

The parameters for the scaling action.

cooldown

cooldown: string

the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format.

direction

direction: ScaleDirection

the scale direction. Whether the scaling action increases or decreases the number of instances. Possible values include: 'None', 'Increase', 'Decrease'

serializedName

serializedName: string = "ScaleAction"

Optional value

value: undefined | string

the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. Default value: '1'.

type

type: object

the type of action that should occur when the scale rule fires. Possible values include: 'ChangeCount', 'PercentChangeCount', 'ExactCount'

className

className: string = "ScaleAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cooldown

cooldown: object

required

required: true = true

serializedName

serializedName: string = "cooldown"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

direction

direction: object

required

required: true = true

serializedName

serializedName: string = "direction"

type

type: object

allowedValues

allowedValues: string[] = ["None","Increase","Decrease"]

name

name: "Enum" = "Enum"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["ChangeCount","PercentChangeCount","ExactCount"]

name

name: "Enum" = "Enum"

value

value: object

defaultValue

defaultValue: string = "1"

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ScaleCapacity

ScaleCapacity: object

The number of instances that can be used during this profile.

default

default: string

the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default.

maximum

maximum: string

the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription.

minimum

minimum: string

the minimum number of instances for the resource.

serializedName

serializedName: string = "ScaleCapacity"

type

type: object

className

className: string = "ScaleCapacity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

default

default: object

required

required: true = true

serializedName

serializedName: string = "default"

type

type: object

name

name: "String" = "String"

maximum

maximum: object

required

required: true = true

serializedName

serializedName: string = "maximum"

type

type: object

name

name: "String" = "String"

minimum

minimum: object

required

required: true = true

serializedName

serializedName: string = "minimum"

type

type: object

name

name: "String" = "String"

Const ScaleRule

ScaleRule: object

A rule that provide the triggers and parameters for the scaling action.

metricTrigger

metricTrigger: MetricTrigger

the trigger that results in a scaling action.

scaleAction

scaleAction: ScaleAction

the parameters for the scaling action.

serializedName

serializedName: string = "ScaleRule"

type

type: object

className

className: string = "ScaleRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metricTrigger

metricTrigger: object

required

required: true = true

serializedName

serializedName: string = "metricTrigger"

type

type: object

className

className: string = "MetricTrigger"

name

name: "Composite" = "Composite"

scaleAction

scaleAction: object

required

required: true = true

serializedName

serializedName: string = "scaleAction"

type

type: object

className

className: string = "ScaleAction"

name

name: "Composite" = "Composite"

Const Schedule

Schedule: object

Defines how often to run the search and the time interval.

frequencyInMinutes

frequencyInMinutes: number

frequency (in minutes) at which rule condition should be evaluated.

serializedName

serializedName: string = "Schedule"

timeWindowInMinutes

timeWindowInMinutes: number

Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

frequencyInMinutes

frequencyInMinutes: object

required

required: true = true

serializedName

serializedName: string = "frequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

timeWindowInMinutes

timeWindowInMinutes: object

required

required: true = true

serializedName

serializedName: string = "timeWindowInMinutes"

type

type: object

name

name: "Number" = "Number"

Const SenderAuthorization

SenderAuthorization: object

the authorization used by the user who has performed the operation that led to this event. This captures the RBAC properties of the event. These usually include the 'action', 'role' and the 'scope'

Optional action

action: undefined | string

the permissible actions. For instance: microsoft.support/supporttickets/write

Optional role

role: undefined | string

the role of the user. For instance: Subscription Admin

Optional scope

scope: undefined | string

the scope.

serializedName

serializedName: string = "SenderAuthorization"

type

type: object

className

className: string = "SenderAuthorization"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "action"

type

type: object

name

name: "String" = "String"

role

role: object

serializedName

serializedName: string = "role"

type

type: object

name

name: "String" = "String"

scope

scope: object

serializedName

serializedName: string = "scope"

type

type: object

name

name: "String" = "String"

Const SmsReceiver

SmsReceiver: object

An SMS receiver.

countryCode

countryCode: string

The country code of the SMS receiver.

name

name: string

The name of the SMS receiver. Names must be unique across all receivers within an action group.

phoneNumber

phoneNumber: string

The phone number of the SMS receiver.

serializedName

serializedName: string = "SmsReceiver"

Optional status

The status of the receiver. Possible values include: 'NotSpecified', 'Enabled', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SmsReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

countryCode

countryCode: object

required

required: true = true

serializedName

serializedName: string = "countryCode"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

phoneNumber

phoneNumber: object

required

required: true = true

serializedName

serializedName: string = "phoneNumber"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","Enabled","Disabled"]

name

name: "Enum" = "Enum"

Const Source

Source: object

Specifies the log search query.

Optional authorizedResources

authorizedResources: string[]

List of Resource referred into query

dataSourceId

dataSourceId: string

The resource uri over which log search query is to be run.

Optional query

query: undefined | string

Log search query. Required for action type - AlertingAction

Optional queryType

queryType: QueryType

Set value to 'ResultCount'. Possible values include: 'ResultCount'

serializedName

serializedName: string = "Source"

type

type: object

className

className: string = "Source"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizedResources

authorizedResources: object

serializedName

serializedName: string = "authorizedResources"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

dataSourceId

dataSourceId: object

required

required: true = true

serializedName

serializedName: string = "dataSourceId"

type

type: object

name

name: "String" = "String"

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "String" = "String"

queryType

queryType: object

serializedName

serializedName: string = "queryType"

type

type: object

name

name: "String" = "String"

Const ThresholdRuleCondition

ThresholdRuleCondition: object

A rule condition based on a metric crossing a threshold.

Optional dataSource

the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

odatatype

odatatype: "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"

Polymorphic Discriminator

operator

the operator used to compare the data and the threshold. Possible values include: 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'

serializedName

serializedName: string = "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"

threshold

threshold: number

the threshold value that activates the alert.

Optional timeAggregation

timeAggregation: TimeAggregationOperator

the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric. Possible values include: 'Average', 'Minimum', 'Maximum', 'Total', 'Last'

Optional windowSize

windowSize: undefined | string

the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.

type

type: object

className

className: string = "ThresholdRuleCondition"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RuleCondition.type.polymorphicDiscriminator

uberParent

uberParent: string = "RuleCondition"

modelProperties

modelProperties: object

operator

operator: object

required

required: true = true

serializedName

serializedName: string = "operator"

type

type: object

allowedValues

allowedValues: string[] = ["GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual"]

name

name: "Enum" = "Enum"

threshold

threshold: object

required

required: true = true

serializedName

serializedName: string = "threshold"

type

type: object

name

name: "Number" = "Number"

timeAggregation

timeAggregation: object

serializedName

serializedName: string = "timeAggregation"

type

type: object

allowedValues

allowedValues: string[] = ["Average","Minimum","Maximum","Total","Last"]

name

name: "Enum" = "Enum"

windowSize

windowSize: object

serializedName

serializedName: string = "windowSize"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const TimeSeriesElement

TimeSeriesElement: object

A time series result type. The discriminator value is always TimeSeries in this case.

Optional data

data: MetricValue[]

An array of data points representing the metric values. This is only returned if a result type of data is specified.

Optional metadatavalues

metadatavalues: MetadataValue[]

the metadata values returned if $filter was specified in the call.

serializedName

serializedName: string = "TimeSeriesElement"

type

type: object

className

className: string = "TimeSeriesElement"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

data

data: object

serializedName

serializedName: string = "data"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricValue"

name

name: "Composite" = "Composite"

metadatavalues

metadatavalues: object

serializedName

serializedName: string = "metadatavalues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataValue"

name

name: "Composite" = "Composite"

Const TimeSeriesInformation

TimeSeriesInformation: object

The time series info needed for calculating the baseline.

sensitivities

sensitivities: string[]

the list of sensitivities for calculating the baseline.

serializedName

serializedName: string = "TimeSeriesInformation"

Optional timestamps

timestamps: Date[] | string[]

the array of timestamps of the baselines.

values

values: number[]

The metric values to calculate the baseline.

type

type: object

className

className: string = "TimeSeriesInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

sensitivities

sensitivities: object

required

required: true = true

serializedName

serializedName: string = "sensitivities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

timestamps

timestamps: object

serializedName

serializedName: string = "timestamps"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

values

values: object

required

required: true = true

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

Const TimeWindow

TimeWindow: object

A specific date-time for the profile.

end

end: Date

the end time for the profile in ISO 8601 format.

serializedName

serializedName: string = "TimeWindow"

start

start: Date

the start time for the profile in ISO 8601 format.

Optional timeZone

timeZone: undefined | string

the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time

type

type: object

className

className: string = "TimeWindow"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

end

end: object

required

required: true = true

serializedName

serializedName: string = "end"

type

type: object

name

name: "DateTime" = "DateTime"

start

start: object

required

required: true = true

serializedName

serializedName: string = "start"

type

type: object

name

name: "DateTime" = "DateTime"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const TriggerCondition

TriggerCondition: object

The condition that results in the Log Search rule.

Optional metricTrigger

metricTrigger: LogMetricTrigger

Trigger condition for metric query rule

serializedName

serializedName: string = "TriggerCondition"

threshold

threshold: number

Result or count threshold based on which rule should be triggered.

thresholdOperator

thresholdOperator: ConditionalOperator

Evaluation operation for rule - 'GreaterThan' or 'LessThan. Possible values include: 'GreaterThan', 'LessThan', 'Equal'

type

type: object

className

className: string = "TriggerCondition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metricTrigger

metricTrigger: object

serializedName

serializedName: string = "metricTrigger"

type

type: object

className

className: string = "LogMetricTrigger"

name

name: "Composite" = "Composite"

threshold

threshold: object

required

required: true = true

serializedName

serializedName: string = "threshold"

type

type: object

name

name: "Number" = "Number"

thresholdOperator

thresholdOperator: object

required

required: true = true

serializedName

serializedName: string = "thresholdOperator"

type

type: object

name

name: "String" = "String"

Const VMInsightsOnboardingStatus

VMInsightsOnboardingStatus: object

VM Insights onboarding status for a resource.

Optional data

data: DataContainer[]

Containers that currently store VM Insights data for the specified resource.

dataStatus

dataStatus: DataStatus

The status of VM Insights data from the resource. When reported as present the data array will contain information about the data containers to which data for the specified resource is being routed. Possible values include: 'present', 'notPresent'

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

onboardingStatus

onboardingStatus: OnboardingStatus

The onboarding status for the resource. Note that, a higher level scope, e.g., resource group or subscription, is considered onboarded if at least one resource under it is onboarded. Possible values include: 'onboarded', 'notOnboarded', 'unknown'

resourceId

resourceId: string

Azure Resource Manager identifier of the resource whose onboarding status is being represented.

serializedName

serializedName: string = "VMInsightsOnboardingStatus"

type

type: object

className

className: string = "VMInsightsOnboardingStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

data

data: object

serializedName

serializedName: string = "properties.data"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataContainer"

name

name: "Composite" = "Composite"

dataStatus

dataStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.dataStatus"

type

type: object

name

name: "String" = "String"

onboardingStatus

onboardingStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.onboardingStatus"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

required

required: true = true

serializedName

serializedName: string = "properties.resourceId"

type

type: object

name

name: "String" = "String"

Const VoiceReceiver

VoiceReceiver: object

A voice receiver.

countryCode

countryCode: string

The country code of the voice receiver.

name

name: string

The name of the voice receiver. Names must be unique across all receivers within an action group.

phoneNumber

phoneNumber: string

The phone number of the voice receiver.

serializedName

serializedName: string = "VoiceReceiver"

type

type: object

className

className: string = "VoiceReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

countryCode

countryCode: object

required

required: true = true

serializedName

serializedName: string = "countryCode"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

phoneNumber

phoneNumber: object

required

required: true = true

serializedName

serializedName: string = "phoneNumber"

type

type: object

name

name: "String" = "String"

Const WebhookNotification

WebhookNotification: object

Webhook notification of an autoscale event.

Optional properties

properties: undefined | object

a property bag of settings. This value can be empty.

serializedName

serializedName: string = "WebhookNotification"

Optional serviceUri

serviceUri: undefined | string

the service address to receive the notification.

type

type: object

className

className: string = "WebhookNotification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

serviceUri

serviceUri: object

serializedName

serializedName: string = "serviceUri"

type

type: object

name

name: "String" = "String"

Const WebhookReceiver

WebhookReceiver: object

A webhook receiver.

name

name: string

The name of the webhook receiver. Names must be unique across all receivers within an action group.

serializedName

serializedName: string = "WebhookReceiver"

serviceUri

serviceUri: string

The URI where webhooks should be sent.

useCommonAlertSchema

useCommonAlertSchema: boolean

Indicates whether to use common alert schema.

type

type: object

className

className: string = "WebhookReceiver"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

serviceUri

serviceUri: object

required

required: true = true

serializedName

serializedName: string = "serviceUri"

type

type: object

name

name: "String" = "String"

useCommonAlertSchema

useCommonAlertSchema: object

required

required: true = true

serializedName

serializedName: string = "useCommonAlertSchema"

type

type: object

name

name: "Boolean" = "Boolean"

Const WorkspaceInfo

WorkspaceInfo: object

Information about a Log Analytics Workspace.

customerId

customerId: string

Log Analytics workspace identifier.

id

id: string

Azure Resource Manager identifier of the Log Analytics Workspace.

location

location: string

Location of the Log Analytics workspace.

serializedName

serializedName: string = "WorkspaceInfo"

type

type: object

className

className: string = "WorkspaceInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customerId

customerId: object

required

required: true = true

serializedName

serializedName: string = "properties.customerId"

type

type: object

name

name: "String" = "String"

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const actionGroupName

actionGroupName: object

parameterPath

parameterPath: string = "actionGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "actionGroupName"

type

type: object

name

name: "String" = "String"

Const activityLogAlertName

activityLogAlertName: object

parameterPath

parameterPath: string = "activityLogAlertName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "activityLogAlertName"

type

type: object

name

name: "String" = "String"

Const aggregation

aggregation: object

parameterPath

parameterPath: string[] = ["options","aggregation"]

mapper

mapper: object

serializedName

serializedName: string = "aggregation"

type

type: object

name

name: "String" = "String"

Const apiVersion0

apiVersion0: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2015-04-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion1

apiVersion1: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2016-03-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion10

apiVersion10: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2018-11-27-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion2

apiVersion2: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-05-01-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion3

apiVersion3: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2019-03-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion4

apiVersion4: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-04-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion5

apiVersion5: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2018-01-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion6

apiVersion6: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-11-01-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion7

apiVersion7: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2018-03-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion8

apiVersion8: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2018-04-16"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion9

apiVersion9: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-12-01-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const autoscaleSettingName

autoscaleSettingName: object

parameterPath

parameterPath: string = "autoscaleSettingName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "autoscaleSettingName"

type

type: object

name

name: "String" = "String"

Const discriminators

discriminators: object

Action

Action: CompositeMapper = Action

Action.Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction

Action.Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction: CompositeMapper = AlertingAction

Action.Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction

Action.Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction: CompositeMapper = LogToMetricAction

MetricAlertCriteria

MetricAlertCriteria: CompositeMapper = MetricAlertCriteria

MetricAlertCriteria.Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

MetricAlertCriteria.Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: CompositeMapper = MetricAlertMultipleResourceMultipleMetricCriteria

MetricAlertCriteria.Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

MetricAlertCriteria.Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: CompositeMapper = MetricAlertSingleResourceMultipleMetricCriteria

MultiMetricCriteria

MultiMetricCriteria: CompositeMapper = MultiMetricCriteria

MultiMetricCriteria.StaticThresholdCriterion

MultiMetricCriteria.StaticThresholdCriterion: CompositeMapper = MetricCriteria

RuleAction

RuleAction: CompositeMapper = RuleAction

RuleAction.Microsoft.Azure.Management.Insights.Models.RuleEmailAction

RuleAction.Microsoft.Azure.Management.Insights.Models.RuleEmailAction: CompositeMapper = RuleEmailAction

RuleAction.Microsoft.Azure.Management.Insights.Models.RuleWebhookAction

RuleAction.Microsoft.Azure.Management.Insights.Models.RuleWebhookAction: CompositeMapper = RuleWebhookAction

RuleCondition

RuleCondition: CompositeMapper = RuleCondition

RuleCondition.Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition

RuleCondition.Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition: CompositeMapper = LocationThresholdRuleCondition

RuleCondition.Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition

RuleCondition.Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition: CompositeMapper = ManagementEventRuleCondition

RuleCondition.Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition

RuleCondition.Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition: CompositeMapper = ThresholdRuleCondition

RuleDataSource

RuleDataSource: CompositeMapper = RuleDataSource

RuleDataSource.Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource

RuleDataSource.Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource: CompositeMapper = RuleManagementEventDataSource

RuleDataSource.Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource

RuleDataSource.Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource: CompositeMapper = RuleMetricDataSource

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const incidentName

incidentName: object

parameterPath

parameterPath: string = "incidentName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "incidentName"

type

type: object

name

name: "String" = "String"

Const interval

interval: object

parameterPath

parameterPath: string[] = ["options","interval"]

mapper

mapper: object

serializedName

serializedName: string = "interval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const logProfileName

logProfileName: object

parameterPath

parameterPath: string = "logProfileName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "logProfileName"

type

type: object

name

name: "String" = "String"

Const metricName

metricName: object

parameterPath

parameterPath: string = "metricName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "metricName"

type

type: object

name

name: "String" = "String"

Const metricnames

metricnames: object

parameterPath

parameterPath: string[] = ["options","metricnames"]

mapper

mapper: object

serializedName

serializedName: string = "metricnames"

type

type: object

name

name: "String" = "String"

Const metricnamespace

metricnamespace: object

parameterPath

parameterPath: string[] = ["options","metricnamespace"]

mapper

mapper: object

serializedName

serializedName: string = "metricnamespace"

type

type: object

name

name: "String" = "String"

Const name

name: object

parameterPath

parameterPath: string = "name"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const orderby

orderby: object

parameterPath

parameterPath: string[] = ["options","orderby"]

mapper

mapper: object

serializedName

serializedName: string = "orderby"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const resourceUri

resourceUri: object

parameterPath

parameterPath: string = "resourceUri"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceUri"

type

type: object

name

name: "String" = "String"

Const resultType

resultType: object

parameterPath

parameterPath: string[] = ["options","resultType"]

mapper

mapper: object

serializedName

serializedName: string = "resultType"

type

type: object

allowedValues

allowedValues: string[] = ["Data","Metadata"]

name

name: "Enum" = "Enum"

Const ruleName

ruleName: object

parameterPath

parameterPath: string = "ruleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ruleName"

type

type: object

name

name: "String" = "String"

Const select

select: object

parameterPath

parameterPath: string[] = ["options","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const sensitivities

sensitivities: object

parameterPath

parameterPath: string[] = ["options","sensitivities"]

mapper

mapper: object

serializedName

serializedName: string = "sensitivities"

type

type: object

name

name: "String" = "String"

Const startTime

startTime: object

parameterPath

parameterPath: string[] = ["options","startTime"]

mapper

mapper: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "String" = "String"

Const statusName

statusName: object

parameterPath

parameterPath: string = "statusName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "statusName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const timespan

timespan: object

parameterPath

parameterPath: string[] = ["options","timespan"]

mapper

mapper: object

serializedName

serializedName: string = "timespan"

type

type: object

name

name: "String" = "String"

Const top

top: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "top"

type

type: object

name

name: "Number" = "Number"

Generated using TypeDoc